1)接口功能介绍
eip列表查询。
2)接口约束
只返回有效的ip列表。
3)URI
GET /v1/describeEipAddress。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
page | 否 | Integer | 默认值为1 当前页数 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,默认值为10 | 10 | |
ip | 否 | String | 根据ip进行模糊查询,不填默认不生效 | 10.0.0.1 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 1 | 总页数 | |
total | 是 | Integer | 6 | 记录总个数 | |
page | 是 | Integer | 1 | 当前页数 | |
perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
eipList | 是 | List | eip信息列表 | eipList |
表 eipList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
eipId | 否 | String | 弹性公网ip id | 1583 | |
ip | 否 | String | 弹性公网ip地址 | 192.168.1.105 | |
ipType | 否 | String | 弹性公网ip类型。IPV4 | 10.0.0.0 | |
ipPriceType | 否 | String | 弹性公网ip计费类型 取值范围:FREE-免费 | FREE | |
bandwidthName | 否 | String | 弹性公网ip绑定的带宽规格名称 | bw17 | |
bandwidthPriceType | 否 | String | 弹性公网ip绑定的带宽计费方式,取值范围:TRAFFIC_BILLING-按使用流量 | FIXED_BANDWIDTH | |
bandwidthSize | 否 | Integer | 弹性公网ip绑定的带宽大小 | 1 | |
instanceType | 否 | String | 绑定的实例类型 ,UNBOUND:未绑定,EVM:直通EVM绑定(创建直通EVM时,默认生成的eip-实例绑定),VPC_EVM-VPC模式EVM绑定,NAT-NAT网关绑定,SLB-负载均衡实例绑定 | UNBOUND | |
instanceId | 否 | String | 绑定的实例id | evm-xxx | |
createTime | 否 | String | 弹性公网ip创建时间(Unix时间戳,秒) | 1610691385 | |
updateTime | 否 | String | 弹性公网ip更新时间(Unix时间戳,秒) | 1610930097 | |
noBandwidthLimit | 否 | Boolean | 否否有带宽限制(false:有带宽限制。true:没有带宽限制) | true | |
vpcId | 否 | String | 所属私有网络的Id | 161 | |
ipv6Addr | 否 | String | ipv6地址 | 240e:5a:e001:1::11 | |
Isp | 否 | String | 运营商,TELECOM-电信,UNICOM-联通,MOBILE-移动 | TELECOM |
6)请求示例
GET http://{host}/v1/describeEipAddress?ip=10&nodeCode=yn-lincang-1&page=1&perPageNum=10
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"eipList": [
{
"bandwidthPriceType": "TRAFFIC_BILLING",
"updateTime": "1669600202",
"bandwidthName": "bw-ce0b6cei15ho6kq6qi9g",
"ipType": "IPV4",
"instanceId": "evm-cdtf43f04suugak385ng",
"ip": "220.164.130.10",
"Isp": "TELECOM",
"eipId": "5978",
"bandwidthSize": 50,
"createTime": "1668585270",
"vpcId": "1094",
"ipPriceType": "PAY_FOR_USE",
"ipv6Addr": "",
"instanceType": "VPC_EVM",
"noBandwidthLimit": false
}
],
"totalPage": 1,
"total": 1,
"page": 1,
"perPageNum": 10
},
"requestId": "c524d4ef-4795-42c9-856e-1dd7778670c9"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |