调用DescribeAccounts接口查询集群的账号信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:DescribeAccounts | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 数仓版集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的集群 ID。
| amv-bp11q28kvl688**** |
AccountName | string | 否 | 数据库账号。 说明
此参数不填写时,默认返回所有数据库账号信息。
| test_accout |
AccountType | string | 否 | 账号类型,不填写时默认查询所有类型的账号信息。取值说明:
| Super |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9CCFAAB4-97B7-5800-B9F2-685EB596E3EF",
"AccountList": {
"DBAccount": [
{
"AccountStatus": "Available",
"AccountDescription": "C@test",
"AccountType": "Super",
"AccountName": "adb_user1"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-30 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |