调用DescribeAccounts查找指定Redis实例的帐户列表信息或实例中某个账号的信息。

说明 该API仅支持4.0或以上版本的Redis实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAccounts

系统规定参数,取值:DescribeAccounts。

InstanceId String r-bp1xxxxxxxxxxxxx

实例ID。

AccountName String demoaccount

账号名。以小写字母开头,由小写字母、数字或下划线组成,长度不超过16个字符。

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 6C9E114C-217C-4118-83C0-B40702221161

请求ID。

Accounts Array

由账号信息组成的集合。

InstanceId String r-bp1xxxxxxxxxxxxx

实例ID。

AccountName String demoaccount

账号名称。

AccountStatus String Available

账号状态:

  • Unavailable(不可用)
  • Available(可用)
AccountType String Normal

账号类型:

  • Normal(普通账号)
  • Super(超级账号)
AccountDescription String this is a test account

账号备注信息。

DatabasePrivileges Array

账号权限列表。

AccountPrivilege String RoleReadWrite

账号权限:

  • RoleReadOnly(只读)
  • RoleReadWrite(读写,默认值)
  • RoleRepl(复制)
说明 复制权限支持读写,且支持使用SYNC/PSYNC命令。

示例

请求示例

https://r-kvstore.aliyuncs.com/
?Action=DescribeAccounts
&InstanceId=r-bp1xxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DescribeAccountsResponse>
      <Accounts>
        <Account>
              <DatabasePrivileges>
                <DatabasePrivilege>
                      <AccountPrivilege>RoleReadWrite</AccountPrivilege>
                </DatabasePrivilege>
              </DatabasePrivileges>
              <AccountStatus>Available</AccountStatus>
              <InstanceId>r-bp1xxxxxxxxxxxxx</InstanceId>
              <AccountName>r-bp1xxxxxxxxxxxxx</AccountName>
              <PrivExceeded>0</PrivExceeded>
              <AccountType>Normal</AccountType>
        </Account>
      </Accounts>
      <RequestId>6C9E114C-217C-4118-83C0-B40702221161</RequestId>
</DescribeAccountsResponse>

JSON 格式

{
    "Accounts": {
        "Account": [
            {
                "DatabasePrivileges": {
                    "DatabasePrivilege": [
                        {
                            "AccountPrivilege": "RoleReadWrite"
                        }
                    ]
                },
                "AccountStatus": "Available",
                "InstanceId": "r-bp1xxxxxxxxxxxxx",
                "AccountName": "r-bp1xxxxxxxxxxxxx",
                "PrivExceeded": "0",
                "AccountType": "Normal"
            }
        ]
    },
    "RequestId": "6C9E114C-217C-4118-83C0-B40702221161"
}

错误码

访问错误中心查看更多错误码。