查询实例角色信息v2
更新时间 2025-10-22 18:12:24
最近更新时间: 2025-10-22 18:12:24
接口功能介绍
查询文档数据库实例的角色信息
接口约束
无
URI
GET /DDS2/v2/openApi/describeInstanceRole
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394************************* |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询文档数据库服务的实例角色信息成功 | |
| returnObj | Object | 返回对象数组 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| elasticIp | String | 弹性ip | 127.0.0.1 | |
| node | String | 该mongodb的标签，规定为“set_ + 三个尾部ip + 端口号” | set_1098350_1 | |
| role | String | 角色 | master | |
| alive | Integer | 取自mongodb中的ok属性 | 0 | |
| vpcIpv6 | String | vpc内部的ipv6地址 | ||
| port | String | 访问该mongodb的端口 | 888 | |
| resId | Integer | 唯一标志该mongodb | 67 | |
| outerElasticIpId | String | eipId | eip-qa0lwiyqe7 | |
| allowBeMaster | Boolean | 允许切换成为备用节点 | true | |
| memory | Integer | 内存 | 12 | |
| usedSpace | String | 已使用空间 | null | |
| type | String | 组件类型 | null | |
| azDisplayName | String | 可用区展示名 | az1 | |
| azId | String | 可用区id | ||
| ipv6Bind | Byte | 绑定ipv6带宽标记位, 0表示未绑定, 1表示绑定 | ||
| uuid | String | 机器uuid | ||
| diskSize | String | 存储空间 | ||
| host | String | 机器节点的vpc ip地址 | ||
| prodInstSetName | String | 实例set名称 | ||
| cpuCount | Integer | cpu核数 | ||
| realIp | String | 实际管理ip | ||
| ipv6Cidrs | String | ipv6 网段 | ||
| prodType | Byte | 节点类型（分片集群才有该值） | ||
| regionId | String | 资源池id | ||
| prodInstId | String | 实例id |
枚举参数
无
请求示例
请求url
/v1/openApi/describeInstanceRole?prodInstId=60d420bffb394*************************
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询文档数据库服务的实例角色信息成功",
"returnObj": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.***.***",
"prodInstId": "60d420bffb394*************************",
"type": null,
"resId": 67
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
