Help Center/ Distributed Cache Service/ API Reference/ API V2/ Account Management/ Listing ACL Accounts
Updated on 2025-05-13 GMT+08:00
View PDF

Listing ACL Accounts

Function

This API is used to query the ACL account list.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

accounts

Array of AclAccountResp objects

ACL account list.
Table 3 AclAccountResp

Parameter

Type

Description

account_id

String

Account ID.

account_name

String

Account name.

account_type

String

Account type. Options: normal and default.

instance_id

String

ID of the instance to which the account belongs.

status

String

ACL account status.

Options:

  • CREATING: The account is being created.

  • AVAILABLE: The account is available.

  • DELETEFAILED: The account fails to be deleted.

  • DELETING: The account is being deleted.

  • UPDATING: The account is being updated.

  • ERROR: The account is abnormal.

account_role

String

Account permission. Options: read (read-only) and write (read/write).

description

String

Account description.

error_code

String

Error code. This parameter is not used currently and is set to null.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Example Requests

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

Example Responses

Status code: 200

ACL accounts listed successfully.

{
  "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" : "This is a read-only account.",
    "error_code" : null
  } ]
}

Status code: 400

Invalid request.

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

Status Codes

Status Code

Description

200

ACL accounts listed successfully.

400

Invalid request.

401

Invalid authentication information.

403

Request rejected.

404

The requested resource could not be found.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Account Management