Help Center> Distributed Cache Service> API Reference> Lifecycle Management APIs> Querying All DCS Instances of a Tenant
View PDF

Querying All DCS Instances of a Tenant

Function

This API is used to query DCS instances of a tenant, and allows you to specify query criteria.

URI

GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

start

Integer

No

Start number for querying DCS instances. It cannot be lower than 1.

By default, the start number is 1.

limit

Integer

No

Number of DCS instances displayed on each page.

Minimum value: 1

Maximum value: 2000

If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page.

name

String

No

DCS instance name.

id

String

No

Instance ID.

status

String

No

DCS instance status. For details about status, see DCS Instance Statuses.

ip

String

No

IP address for connecting to the DCS instance

includeFailure

String

No

An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller.

Options:

  • true: The number of DCS instances that failed to be created will be returned to the API caller.
  • false or others: The number of DCS instances that failed to be created will not be returned to the API caller.

isExactMatchName

String

No

An indicator of whether to perform an exact or fuzzy match based on instance name.

Options:

  • true: exact match
  • false: fuzzy match

Default value: false.

tags

Array of objects

No

Query based on the instance tag key and value. {key} indicates the tag key, and {value} indicates the tag value.

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

Example

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&isExactMatchName=false

Or

GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?tags=dcs001=001,dcs002=002

Request

Request parameters

None

Example request

None

Response

Response parameters

Table 2 describes the response parameters.
Table 2 Parameter description

Parameter

Type

Description

instances

Array

Array of DCS instance details.

instance_num

Integer

Number of DCS instances.
Table 3 Parameter description of the instance array

Parameter

Type

Description

name

String

DCS instance name.

engine

String

Cache engine.

capacity

Integer

Cache capacity.

Unit: GB.

ip

String

IP address for connecting to 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.

domainName

String

Domain name of the instance.

port

Integer

Port number of the cache node.

status

String

Cache instance status. For details about status, see DCS Instance Statuses.

max_memory

Integer

Overall memory size.

Unit: MB.

used_memory

Integer

Size of the used memory.

Unit: MB.

instance_id

String

DCS instance ID.

engine_version

String

Cache engine version.

internal_version

String

Internal DCS version.

charging_mode

Integer

Billing mode. Options: 0: pay-per-use; 1: yearly/monthly.

capacity_minor

String

Small-scale cache capacity. Unit: GB.

vpc_id

String

VPC ID.

vpc_name

String

VPC name.

created_at

String

Time at which the DCS instance is created. For example, 2017-03-31T12:24:46.297Z.

error_code

String

Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see Error Codes.

user_id

String

User ID.

user_name

String

Username.

maintain_begin

String

Time at which the maintenance time window starts. Format: HH:mm:ss.

maintain_end

String

Time at which the maintenance time window ends. Format: HH:mm:ss.

no_password_access

String

An indicator of whether a DCS instance can be accessed in password-free mode.

  • true: indicates that a DCS instance can be accessed without a password.
  • false: indicates that a DCS instance can be accessed only after password authentication.

access_user

String

Username used for accessing a DCS instance with password authentication.

enable_publicip

Boolean

An indicator of whether public access is enabled for a DCS Redis instance.

  • true: enabled.
  • false: disabled.

publicip_address

String

Elastic IP address bound to a DCS Redis instance.

The parameter value is null if public access is disabled.

publicip_id

String

ID of the elastic IP address bound to a DCS Redis instance.

The parameter value is null if public access is disabled.

enable_ssl

Boolean

An indicator of whether to enable SSL for public access to a DCS Redis instance.

  • true: enabled.
  • false: disabled.

service_upgrade

Boolean

An indicator of whether an upgrade task has been created for a DCS instance.

  • true: yes.
  • false: no.

service_task_id

String

Upgrade task ID.

  • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
  • If the value of service_upgrade is set to false, the value of this parameter is empty.

enterprise_project_id

String

Enterprise project ID.

security_group_id

String

Security group name.

tags

Array of objects

Instance tag key and value.

Example response

{
    "instances": [
        {           
            "name": "dcs-lxy",            
            "engine": "Redis",
            "capacity": 4,
            "ip": "192.168.7.146",
            "domainName": null,
            "port": 6379,
            "status": "CREATING",
            "max_memory": 3277,
            "used_memory": 0,
            "instance_id": "a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71",
             "resource_spec_code": "dcs.master_standby",
            "engine_version": "3.0",
            "internal_version": null,
            "charging_mode": 0,          
            "capacity_minor": null,
            "vpc_id": "c71d9731-9b0c-43e9-ab2a-716af9d9fd55",
            "vpc_name": "CCE-AutoCreate-VPC-7qvs1",       
            "created_at": "2019-09-23T02:40:06.123Z",
            "error_code": null,
            "user_id": "50a4156d334a4a82b8745dc730dc1e00",
            "user_name": "hwstaff_f00443635",
            "maintain_begin": "02:00:00",
            "maintain_end": "06:00:00",
            "no_password_access": "true",
            "access_user": null,
            "enable_publicip": false,
            "publicip_id": null,
            "publicip_address": null,
            "enable_ssl": false,
            "service_upgrade": false,
            "service_task_id": "",
            "enterprise_project_id": "0",
            "tags": [
                {
                    "key": "dcs001",
                    "value": "001"
                },
                {
                    "key": "dcs002",
                    "value": "002"
                }
            ],
            "security_group_id": "0cc8fdb7-872a-49da-a062-88ccc39463b5"
        }],
    "instance_num": 1
}

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 4 Status code

Status Code

Description

200

All DCS instances of the tenant queried successfully.