文档首页/ 分布式缓存服务 DCS/ API参考 (联盟区域) / API V2（推荐）/ 账号管理/ 查询ACL账户列表
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询ACL账户列表

功能介绍

查询ACL账户列表。

URI

GET /v2/{project_id}/instances/{instance_id}/accounts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

accounts

Array of AclAccountResp objects

参数解释：

ACL账号列表。
表3 AclAccountResp

参数

参数类型

描述

account_id

String

参数解释：

ACL账号ID。

取值范围：

不涉及。

account_name

String

参数解释：

ACL账号名。

取值范围：

不涉及。

account_type

String

参数解释：

ACL账号类型。

取值范围：

normal：普通账号。

default：默认账号。

instance_id

String

参数解释：

账号所属实例ID。

取值范围：

不涉及。

status

String

参数解释：

ACL账号状态。

取值范围：

  • CREATING：账号创建中。

  • AVAILABLE：账号可用。

  • DELETEFAILED：账号删除失败。

  • DELETING：账号删除中。

  • UPDATING：账号更新中。

  • ERROR：账号异常。

account_role

String

参数解释：

账号权限。

取值范围：

read：只读账号。

write：读写账号。

description

String

参数解释：

账号描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码（该参数暂未使用，赋值为null）。

取值范围：

不涉及。

account_read_policy

String

参数解释：

指定账号的读请求转发到主节点或备节点。

取值范围：

  • master：读请求转发到主节点。

  • replica：读请求转发到备节点。

  • master-replica：读请求转发到主备节点。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/accounts

响应示例

状态码：200

ACL账户列表。

{
  "accounts" : [ {
    "account_id" : "cb067c67-f08b-4024-af14-f78b58b76a44",
    "account_name" : "roUser",
    "account_type" : "normal",
    "instance_id" : "10fda556-51c3-4cfa-ab6f-37667428da6e",
    "status" : "available",
    "account_role" : "read",
    "description" : "这是一个只读账号",
    "error_code" : null
  } ]
}

状态码：400

非法请求。

{
  "error_code" : "DCS.4964",
  "error_msg" : "Failed to query acl list."
}

状态码

状态码

描述

200

ACL账户列表。

400

非法请求。

401

认证失败。

403

请求被拒绝。

404

路径错误。

500

内部错误。

错误码

请参见错误码。

父主题： 账号管理