文档首页/ 分布式数据库中间件 DDM/ API参考/ API(推荐)/ 实例管理/ 获取实例绑定的弹性公网IP信息V3
更新时间:2025-11-28 GMT+08:00
分享

获取实例绑定的弹性公网IP信息V3

功能介绍

获取DDM实例绑定的弹性公网IP信息

URI

GET /v3/{project_id}/instances/{instance_id}/public-ips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

DDM实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页参数:起始值 [大于等于0] 。默认值是0。

limit

Integer

分页参数:每页多少条 [大于0且小于等于128]。默认值是10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

public_ip_list

PublicIpInfo object

DDM绑定的弹性公网IP信息

total_count

Integer

总数

表5 PublicIpInfo

参数

参数类型

描述

id

String

弹性公网IP唯一标识。

type

String

弹性公网IP的类型。

public_ip

String

弹性公网IP的地址。

private_ip

String

绑定弹性公网IP的私有IP地址。

binding_entity_id

String

绑定弹性公网IP的实体ID。

binding_entity_name

String

绑定弹性公网IP的实体名称。

binding_entity_type

String

绑定弹性公网IP的实体类型(目前只支持绑定node)。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

响应示例

状态码:200

执行成功

{
  "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"
  } ],
  "total_count" : 1
}

状态码:400

bad request

{
  "error_code" : "DBS.280001",
  "error_msg" : "Parameter error."
}

状态码:500

server error

{
  "error_code" : "DBS.280001",
  "error_msg" : "Parameter error."
}

状态码

状态码

描述

200

执行成功

400

bad request

500

server error

错误码

请参见错误码

相关文档