Querying All DCS Instances

project_id

Yes

String

Parameter description:

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

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

instance_id

No

String

Parameter description:

Instance ID, which can be viewed on the instance details page on the DCS console.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

include_failure

No

String

Parameter description:

Indicates whether to return the number of instances that fail to be created.

Constraints:

N/A.

Value range:

• true: yes

• false: no

Default value:

false

include_delete

No

String

Parameter description:

Whether to return the number of instances that have been deleted.

Constraints:

N/A.

Value range:

• true: yes

• false: no

Default value:

false

name

No

String

Parameter description:

Instance name.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

offset

No

Integer

Parameter description:

Offset where the query starts

Constraints:

N/A.

Value range:

≥ 0

Default value:

0

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A.

Value range:

1–1000

Default value:

10

status

No

String

Parameter description:

Instance status.

Constraints:

N/A.

Value range:

For details, see DCS Instance Statuses.

Default value:

N/A.

name_equal

No

String

Parameter description:

Exact query by instance name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

tags

No

String

Parameter description:

Query by instance tag key-value pair. {key} indicates the tag key, and {value} indicates the tag value.

Constraints:

To query instances with multiple tag keys and values, separate key-value pairs with commas (,).

Value range:

N/A.

Default value:

N/A.

ip

No

String

Parameter description:

IP address of a DCS instance, for example, 192.168.7.146 It can be viewed on the instance details page on the DCS console.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

capacity

No

String

Parameter description:

DCS instance memory, in GB.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

instance_num

Integer

Parameter description:

Number of instances.

Value range:

N/A.

instances

Array of InstanceListInfo objects

Parameter description:

Instance details array.

Value range:

N/A.

publicip_id

String

Parameter description:

ID of the EIP bound to a DCS Redis instance.

This parameter is reserved. The value is null.

Value range:

N/A.

vpc_name

String

Parameter description:

VPC name.

Value range:

N/A.

charging_mode

Integer

Parameter description:

Billing mode.

Value range:

0: pay-per-use

vpc_id

String

Parameter description:

ID of the VPC where the DCS Redis instance is located.

Value range:

N/A.

subnet_id

String

Parameter description:

ID of the subnet bound to a DCS Redis instance.

Value range:

N/A.

security_group_id

String

Parameter description:

ID of the security group bound to the DCS Redis instance.

Value range:

N/A.

created_at

String

Parameter description:

Instance creation time. For example, 2017-03-31T12:24:46.297Z.

Value range:

N/A.

updated_at

String

Parameter description:

Instance update time. Format: 2017-03-31T19:24:46.297Z.

Value range:

N/A.

enable_ssl

Boolean

Parameter description:

This parameter is reserved.

Value range:

N/A

max_memory

Integer

Parameter description:

Total memory of an instance, in MB.

Value range:

N/A.

used_memory

Integer

Parameter description:

Used memory of an instance, in MB.

Value range:

N/A.

publicip_address

String

Parameter description:

EIP bound to the DCS Redis instance.

This parameter is reserved. The value is null.

Value range:

N/A.

capacity

Integer

Parameter description:

Cache size of the instance, in GB.

Value range:

N/A.

capacity_minor

String

Parameter description:

Memory of a DCS instance whose size is less than 1 GB, in GB.

Value range:

N/A.

order_id

String

Parameter description:

Order ID. The value is null when a pay-per-use instance is created.

Value range:

N/A.

maintain_begin

String

Parameter description:

UTC time when the maintenance time window starts. The format is HH:mm:ss.

Value range:

N/A.

maintain_end

String

Parameter description:

UTC time when the maintenance time window ends. The format is HH:mm:ss.

Value range:

N/A.

engine

String

Parameter description:

Cache engine.

Value range:

Redis

engine_version

String

Parameter description:

Cache version.

Value range:

The engine version of a DCS Redis instance can be:

• 4.0

• 5.0

• 6.0

• 7.0

service_upgrade

Boolean

Parameter description:

Whether an upgrade task has been created for an instance.

Value range:

• true: yes

• false: no

no_password_access

String

Parameter description:

Indicates whether password-protected access is enabled for the instance.

Value range:

• true: no

• false: yes

service_task_id

String

Parameter description:

ID of an upgrade task.

• This parameter is valid when service_upgrade is set to true.

• This parameter is blank when service_upgrade is set to false.

Value range:

N/A.

ip

String

Parameter description:

IP address of the DCS instance. For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1, 192.168.0.2.

Value range:

N/A.

access_user

String

Parameter description:

Username for accessing a password-protected DCS instance.

Value range:

N/A.

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A.

enable_publicip

Boolean

Parameter description:

Value range:

port

Integer

Parameter description:

Port of a DCS instance.

Value range:

N/A.

user_id

String

Parameter description:

ID of the user to which the instance belongs.

Value range:

N/A.

user_name

String

Parameter description:

Username of the instance.

Value range:

N/A.

domain_name

String

Parameter description:

Domain name of a instance.

Value range:

N/A.

readonly_domain_name

String

Parameter description:

Read-only domain name of the instance. This parameter is available only for master/standby instances.

Value range:

N/A.

name

String

Parameter description:

Instance name.

Value range:

N/A.

spec_code

String

Parameter description:

Product flavor code.

Value range:

N/A.

status

String

Parameter description:

Instance status.

Value range:

For details, see DCS Instance Statuses.

tags

Array of ResourceTags objects

Parameter description:

Instance tag key and value.

Value range:

N/A.

enterprise_project_id

String

Parameter description:

Enterprise project ID.

Value range:

N/A.

description

String

Parameter description:

Instance description.

Value range:

N/A.

cpu_type

String

Parameter description:

CPU type of the instance.

Value range:

• x86_64: x86-based

• aarch64: Arm-based

az_codes

Array of strings

Parameter description:

AZs where there are available resources.

Value range:

N/A.

features

Features object

Parameter description:

Features supported by the instance.

Value range:

N/A.

sub_status

String

Parameter description:

Instance sub-status.

Value range:

N/A.

key

String

Parameter description:

Tag key.

Value range:

N/A

value

String

Parameter description:

Tag value.

Value range:

N/A

support_acl

Boolean

Parameter description:

Whether ACL is supported.

Value range:

• true: Yes

• false: No

support_transparent_client_ip

Boolean

Parameter description:

Whether client IP pass-through is enabled.

Value range:

• true: Yes

• false: No

support_ssl

Boolean

Parameter description:

Whether SSL is supported.

Value range:

• true: Yes

• false: No

support_audit_log

Boolean

Parameter description:

Whether audit logs are supported.

Value range:

• true: Yes

• false: No

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

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

Value range:

N/A.

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

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

Value range:

N/A.

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

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

Value range:

N/A.

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

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

Value range:

N/A.

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

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

Value range:

N/A.

200

All instances are listed successfully.

400

Invalid request.

401

Invalid authentication information.

403

The request is rejected.

404

The requested resource is not found.

500

Internal service error.