DescribeEips
1. 接口描述
本接口用于指定条件查询已创建的弹性IPv4的信息。用户可以根据ID、名称等信息来搜索。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
eipIds
否
Array of String
按照 EIP 的唯一 ID 过滤。
regionId
否
String
按照 EIP 所属节点ID过滤。
name
否
String
按照 EIP 的显示名称过滤,该字段支持模糊匹配。
isDefault
否
Boolean
按照 EIP 的默认属性进行过滤。
pageSize
否
Integer
返回的分页大小。
默认为20,最大为1000。
pageNum
否
Integer
返回的分页页码。
默认为1。
privateIpAddress
否
String
按照 EIP 绑定的内网 IP 过滤。
ipAddresses
否
Array of String
按照 EIP 的 IP列表过滤。
ipAddress
否
String
按照 EIP 的 IP 过滤。(不建议继续使用,建议使用ipAddresses字段。)
cidrIds
否
Array of String
按照 EIP 所属的CIDR ID列表 过滤。
instanceId
否
String
按照 EIP 绑定的实例 ID 过滤。
该字段过滤出该实例所绑定的网卡上的 EIP。
associatedId
否
String
按照 EIP 绑定的资源 ID 过滤。
3. 响应结果
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount
Integer
满足过滤条件的EIP总数。
4. 代码示例
1. 1. 根据公网IP查询匹配的IP列表。
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeEips
<Common Request Params>
Request:
{
"ipAddresses": ["128.0.0.1"]
}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
"dataSet": [
{
"eipId": "<eip id>",
"zoneId": "na-east-1",
"ipAddress": "128.0.0.1",
"instanceId": "instanceId1",
"instanceName": "instanceName",
"eipChargeType": "POSTPAID",
"period": 1,
"createTime": "2022-09-25T16:53:38Z",
"expiredTime": "2022-10-25T16:53:38Z",
"eipStatus": "AVAILABLE",
"associatedId": "",
"associatedType": null,
"privateIpAddress":null,
"resourceGroupId": "xx",
"resourceGroupName": "xx"
}
],
totalCount: 1
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
最后更新于