全部产品
Search
文档中心

云原生内存数据库Tair:DescribeAccounts - 查找账号信息

更新时间:Feb 20, 2024

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

接口说明

说明 本接口仅适用于 4.0 或以上版本的 Redis 实例。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeAccountsREAD
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
AccountNamestring

待查询的账号名。

demoaccount

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6C9E114C-217C-4118-83C0-B4070222****
Accountsobject []

Redis 实例的账号信息列表。

AccountDescriptionstring

账号备注信息。

testdec
InstanceIdstring

实例 ID。

r-bp10noxlhcoim2****
AccountTypestring

账号类型,返回值:

  • Normal:普通账号。
  • Super:超级账号。
Normal
AccountStatusstring

账号状态,返回值:

  • Unavailable:不可用。
  • Available:可用。
Available
AccountNamestring

账号名称。

demoaccount
DatabasePrivilegesobject []

账号权限列表。

AccountPrivilegestring

账号权限,返回值:

  • RoleReadOnly:只读权限。
  • RoleReadWrite:读写权限,默认值。
RoleReadWrite

示例

正常返回示例

JSON格式

{
  "RequestId": "6C9E114C-217C-4118-83C0-B4070222****",
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "testdec",
        "InstanceId": "r-bp10noxlhcoim2****",
        "AccountType": "Normal",
        "AccountStatus": "Available",
        "AccountName": "demoaccount",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "AccountPrivilege": "RoleReadWrite"
            }
          ]
        }
      }
    ]
  }
}

错误码

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