ListDBAccount--缓存数据库 Redis 企业版-火山引擎

文档中心

立即注册

导航

ListDBAccount

最近更新时间：2024.12.13 17:25:37首次发布时间：2024.12.13 17:25:37

调用 ListDBAccount 接口查询 Redis 企业版实例中的账号信息，包括账号名称、账号角色等。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
AccountName	String	否	default	账号名称。说明若该参数留空，表示不使用账号名称筛选。

返回参数

参数	类型	示例值	描述
Accounts	Object[]		账号信息列表。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ListDBAccount&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****"
}

返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204152005100102120451971763****",
          "Action": "ListDBAccount",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": {
          "Accounts": [
              {
                  "AccountName": "default",
                  "Description": "默认账号",
                  "InstanceId": "redis-cn0212gzmh2xs****",
                  "RoleName": "Administrator"
              }
          ]
     }
}

错误码

更多详情，请参见错误码。