获取实例绑定的弹性公网IP信息V3
功能介绍
获取DDM实例绑定的弹性公网IP信息
URI
GET /v3/{project_id}/instances/{instance_id}/public-ips
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
| instance_id | 是 | String | DDM实例ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 分页参数:起始值 [大于等于0] 。默认值是0。 |
| limit | 否 | Integer | 分页参数:每页多少条 [大于0且小于等于128]。默认值是10。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
- 正常响应参数说明
| 参数 | 参数类型 | 描述 |
|---|---|---|
| public_ip_list | Array of PublicIpInfo objects | DDM绑定的弹性公网IP信息 |
| total_count | Integer | 总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 弹性公网IP唯一标识。 |
| type | String | 弹性公网IP的类型。 枚举值:
|
| public_ip | String | 弹性公网IP的地址。 |
| private_ip | String | 绑定弹性公网IP的私有IP地址。如果binding_entity_type值为node_group,返回为null。 |
| binding_entity_id | String | 绑定弹性公网IP的实体ID。 |
| binding_entity_name | String | 绑定弹性公网IP的实体名称。 |
| binding_entity_type | String | 绑定弹性公网IP的实体类型(目前只支持绑定node)。 枚举值:
|
| group_id | String | 绑定弹性公网IP的组ID。 |
请求示例
获取实例绑定的弹性公网IP
GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/public-ips?offset=0&limit=10 响应示例
- 正常响应示例
{
"public_ip_list" : [ {
"id" : "243a21f1-2e34-4240-b0aa-53236badb84a",
"type" : "5_bgp",
"public_ip" : "10.154.217.126",
"private_ip" : "172.16.0.147",
"binding_entity_id" : "b25495e4cbc14fa4a3869bb7f9c8ff58no09",
"binding_entity_name" : "ddm-test-000201_node_01",
"binding_entity_type" : "node",
"group_id" : "b2018d680f5146099251bccc0b82845cgr09"
} ],
"total_count" : 1
} - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。