接口功能介绍
调用describeInstanceRole接口查询MongoDB实例角色信息。
接口约束
无
URI
GET /v1/openApi/describeInstanceRole
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询XXX信息成功 | |
| returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| elasticIp | 是 | String | 弹性ip | 127.0.0.1 | |
| node | 是 | String | 节点 | set_1098350_1 | |
| role | 是 | String | 角色 | master | |
| alive | 是 | Integer | 取自mongodb中的ok属性 | 0 | |
| vpcIpv6 | 是 | String | vpc内部的ipv6地址 | ||
| port | 是 | String | 主机端口 | 8888 | |
| host | 是 | String | 主机地址 | 127.0.0.1 | |
| prodInstId | 是 | String | 示例id | a649077e15f349cb8b4cde6f7285a568 | |
| type | 是 | Integer | 节点类型（分片集群才有该值） | 0 | |
| resId | 是 | Integer | 唯一标志该mongodb | 67 |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeInstanceRole?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"statusCode": 800,
"message": "查询文档数据库服务的实例角色信息成功",
"returnObj": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"type": null,
"resId": 67
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
