获取指定实例的账号。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
rocketmq:GetInstanceAccount |
get |
*Instance
|
无 | 无 |
请求语法
GET /instances/{instanceId}/account HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
实例 ID |
rmq-cn-20p36ja4m0y |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| username |
string |
否 |
账号名称。 不传则返回默认账号。 |
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Result |
||
| requestId |
string |
请求 ID,每个请求的 ID 都是唯一的,可用于排查和定位问题。 |
B5C59E80-FCFC-5796-ABE4-D39EAAE578E4 |
| success |
boolean |
执行结果是否成功。 |
true |
| data |
object |
返回结果。 |
|
| username |
string |
账号名称。 |
xxx |
| password |
string |
账号密码。 |
************* |
| accountStatus |
string |
账号状态 枚举值:
|
ENABLE |
| remark |
string |
备注 |
test |
| code |
string |
错误码。 |
MissingInstanceId |
| message |
string |
错误信息。 |
The instance cannot be found. |
| httpStatusCode |
integer |
HTTP 状态码。 |
200 |
| dynamicCode |
string |
动态错误码。 |
ConsumerGroupId |
| dynamicMessage |
string |
动态错误信息。 |
instanceId |
示例
正常返回示例
JSON格式
{
"requestId": "B5C59E80-FCFC-5796-ABE4-D39EAAE578E4",
"success": true,
"data": {
"username": "xxx",
"password": "*************",
"accountStatus": "ENABLE",
"remark": "test"
},
"code": "MissingInstanceId",
"message": "The instance cannot be found.",
"httpStatusCode": 200,
"dynamicCode": "ConsumerGroupId",
"dynamicMessage": "instanceId"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。