Querying a DCS instance
Function
This API is used to query the details about a specified DCS instance.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
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. |
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. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
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. |
user_name |
String |
Parameter description: Username of the instance. Value range: N/A. |
created_at |
String |
Parameter description: Creation completion time, for example, 2017-03-31T12:24:46.297Z Value range: N/A. |
description |
String |
Parameter description: Instance description. 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. |
security_group_name |
String |
Parameter description: Name of the tenant security group. Value range: N/A. |
max_memory |
Integer |
Parameter description: Total memory size in MB. Value range: N/A. |
used_memory |
Integer |
Parameter description: Used memory size in MB. Value range: N/A. |
capacity |
Integer |
Parameter description: DCS instance memory, 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. |
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: DCS instance engine. Value range: N/A. |
no_password_access |
String |
Parameter description: Indicates whether password-protected access is enabled for the instance. Value range:
|
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. |
instance_backup_policy |
InstanceBackupPolicy object |
Parameter description: Backup policy. This parameter is available for master/standby, read/write splitting, and cluster instances. Value range: N/A. |
az_codes |
Array of strings |
Parameter description: AZ where the instance is located. The AZ code is returned. Value range: N/A. |
available_zones |
Array of strings |
Parameter description: ID of the AZ where the instance is in. The AZ ID is returned. 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. |
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. |
name |
String |
Parameter description: Instance name. Value range: N/A. |
spec_code |
String |
Parameter description: Product flavor code. Value range: N/A. |
subnet_id |
String |
Parameter description: ID of the subnet bound to a DCS Redis instance. Value range: N/A. |
subnet_name |
String |
Parameter description: Subnet name. Value range: N/A. |
subnet_cidr |
String |
Parameter description: Subnet CIDR block. Value range: N/A. |
engine_version |
String |
Parameter description: Cache version. Value range: The engine version of a DCS Redis instance can be:
|
order_id |
String |
Parameter description: Order ID. Value range: N/A. |
status |
String |
Parameter description: DCS instance status. Value range: For details, see DCS Instance Statuses. |
domain_name |
String |
Parameter description: Domain name of an instance. Value range: N/A. |
readonly_domain_name |
String |
Parameter description: Read-only domain name of an instance. This parameter is available only for master/standby instances. Value range: N/A. |
enable_publicip |
Boolean |
Parameter description: Value range: |
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. |
publicip_address |
String |
Parameter description: EIP bound to the DCS Redis instance. This parameter is reserved. The value is null. Value range: N/A. |
enable_ssl |
Boolean |
Parameter description: This parameter is reserved. Value range: N/A |
service_upgrade |
Boolean |
Parameter description: Whether an upgrade task has been created for an instance. Value range:
|
service_task_id |
String |
Parameter description: ID of an upgrade task.
Value range: N/A. |
enterprise_project_id |
String |
Parameter description: Enterprise project ID. Value range: N/A. |
backend_addrs |
String |
Parameter description: Backend address of a cluster instance. Value range: N/A. |
features |
Features object |
Parameter description: Features supported by the instance. Value range: N/A. |
domain_name_info |
DomainNameInfo object |
Parameter description: Information about instance domain name update and public domain name resolution. Value range: N/A. |
transparent_client_ip_enable |
Boolean |
Parameter description: Whether client IP pass-through is enabled. Value range: N/A. |
sub_status |
String |
Parameter description: Instance sub-status. Value range: N/A. |
tags |
Array of ResourceTags objects |
Parameter description: Instance tag key and value. Value range: N/A. |
cpu_type |
String |
Parameter description: CPU type of the instance. Value range:
|
enterprise_project_name |
String |
Parameter description: Enterprise project name. Value range: N/A. |
update_at |
String |
Parameter description: Update time, for example, 2022-07-06T09:32:16.502Z Value range: N/A. |
product_type |
String |
Parameter description: Instance type. Value range: generic: basic edition |
storage_type |
String |
Parameter description: Storage type. Value range: Memory storage. |
launched_at |
String |
Parameter description: Start time, for example, 2022-07-06T09:32:16.502Z Value range: N/A. |
cache_mode |
String |
Parameter description: DCS instance type. Value range:
|
support_slow_log_flag |
String |
Parameter description: Whether slow query logs are supported. Value range:
|
db_number |
Integer |
Parameter description: Number of databases. Value range: N/A. |
replica_count |
Integer |
Parameter description: Number of replicas. Value range: N/A. |
sharding_count |
Integer |
Parameter description: Number of shards in a cluster instance. Value range: N/A. |
bandwidth_info |
BandwidthInfo object |
Parameter description: Bandwidth information. Value range: N/A. |
cloud_service_type_code |
String |
Parameter description: Cloud service type code. Value range: N/A. |
cloud_resource_type_code |
String |
Parameter description: Cloud resource type code. Value range: N/A. |
inquery_spec_code |
String |
Parameter description: Specification code in the operations system. Value range: N/A. |
free |
String |
Parameter description: This parameter is the same as if_free, is not enabled, and returns null. Value range: N/A |
is_free |
String |
Parameter description: This parameter is reserved and null is returned. Value range: N/A |
libos |
String |
Parameter description: This parameter is reserved and false is returned. Value range: N/A |
crr_role |
String |
Parameter description: This parameter is reserved and null is returned. Value range: N/A |
active_active |
ActiveActiveInfo object |
Parameter description: Instance active-active feature. This parameter is reserved and null is returned. Value range: N/A |
task |
AnyType |
Parameter description: Current instance task. Value range: N/A |
proxy_links |
Array of ProxyLink objects |
Parameter description: Instance proxy connections. This parameter is reserved and null is returned. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
backup_policy_id |
String |
Parameter description: Backup policy ID. Value range: N/A. |
created_at |
String |
Parameter description: Creation time, in the format of 2022-04-11T09:45:24.790Z. Value range: N/A. |
updated_at |
String |
Parameter description: Update time, in the format of 2022-04-12T02:22:03.269Z. Value range: N/A. |
policy |
BackupPolicyResp object |
Parameter description: Backup policy. Value range: N/A. |
tenant_id |
String |
Parameter description: Tenant ID. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
backup_type |
String |
Parameter description: Backup type. Value range:
|
save_days |
Integer |
Parameter description: Retention period, in days. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: 1–7 |
periodical_backup_plan |
BackupPlan object |
Parameter description: Backup plan. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
timezone_offset |
String |
Parameter description: Time zone of the backup. This parameter is no longer used. Value range: N/A. |
backup_at |
Array of integers |
Parameter description: Day on which the backup starts every week. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: 1–7: Monday to Sunday |
period_type |
String |
Parameter description: Interval at which backup is performed, which supports only weekly currently. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: N/A. |
begin_at |
String |
Parameter description: UTC time when the backup starts. For example, 00:00–01:00 indicates that the backup starts at 00:00 (UTC time). The value must be on the hour. The backup interval is 1 hour. The automatic backup policy is retained when automatic backup is switched to manual backup. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
support_acl |
Boolean |
Parameter description: Whether ACL is supported. Value range:
|
support_transparent_client_ip |
Boolean |
Parameter description: Whether client IP pass-through is enabled. Value range:
|
support_ssl |
Boolean |
Parameter description: Whether SSL is supported. Value range:
|
support_audit_log |
Boolean |
Parameter description: Whether audit logs are supported. Value range:
|
Parameter |
Type |
Description |
---|---|---|
support_public_resolve |
Boolean |
Parameter description: Whether to enable public domain name resolution. Value range:
|
is_latest_rules |
Boolean |
Parameter description: Whether the current domain name is the latest. Value range:
|
zone_name |
String |
Parameter description: Region suffix of the domain name. Value range: N/A. |
history_domain_names |
Array of DomainNameEntity objects |
Parameter description: Historical domain name information. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
domain_name |
String |
Parameter description: Historical domain names of the instance. Value range: N/A. |
is_readonly |
Boolean |
Parameter description: Whether the domain name is read-only. Value range:
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Parameter description: Tag key. Value range: N/A |
value |
String |
Parameter description: Tag value. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
begin_time |
Long |
Parameter description: Start time of temporary increase. Value range: N/A. |
end_time |
Long |
Parameter description: End time of temporary increase. Value range: N/A. |
current_time |
Long |
Parameter description: Current time. Value range: N/A. |
bandwidth |
Integer |
Parameter description: Current bandwidth, in Mbit/s. Value range: N/A |
next_expand_time |
Long |
Parameter description: Next increase time. Value range: N/A. |
expand_count |
Integer |
Parameter description: Number of increases. Value range: N/A. |
expand_effect_time |
Long |
Parameter description: Interval between temporary increases. Value range: N/A. |
expand_interval_time |
Long |
Parameter description: Time to the next increase. Value range: N/A. |
max_expand_count |
Integer |
Parameter description: Maximum number of increases. Value range: N/A. |
task_running |
Boolean |
Parameter description: Whether the task is running. Value range: N/A. |
assured_bandwidth |
Integer |
Parameter description: Assured bandwidth, in Mbit/s. Value range: N/A |
max_bandwidth_for_node |
Integer |
Parameter description: Maximum node bandwidth, in Mbit/s. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
active_active_status |
AnyType |
Parameter description: Instance active-active status. Value range: enabled: Can be enabled. disabled: Cannot be enabled. opening: enabled. closing: disabled. |
active_cluster_index |
AnyType |
Parameter description: Instance active-active cluster index. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
ip |
AnyType |
Parameter description: Proxy IPv4. Value range: N/A |
ipv6_ip |
AnyType |
Parameter description: Proxy IPv6. Value range: N/A |
az_code |
AnyType |
Parameter description: AZ where the proxy is located. Value range: N/A |
role |
AnyType |
Parameter description: Proxy role. Value range: N/A |
domain_name |
AnyType |
Parameter description: Proxy domain name. Value range: N/A |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}
Example Responses
Status code: 200
The specified instance is queried successfully.
{ "publicip_id" : null, "vpc_name" : "dcs-beta", "charging_mode" : 0, "enterprise_project_name" : "default", "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", "user_name" : "clouduser", "created_at" : "2022-08-29T08:53:47.319Z", "description" : null, "cache_mode" : "ha", "security_group_id" : "securityGroupId", "enable_ssl" : false, "max_memory" : 128, "publicip_address" : null, "capacity" : 0, "maintain_begin" : "18:00:00", "engine" : "Redis", "maintain_end" : "19:00:00", "capacity_minor" : ".125", "service_upgrade" : false, "subnet_name" : "dcs-beta", "no_password_access" : "true", "service_task_id" : null, "ip" : "192.168.0.251", "subnet_cidr" : "192.168.0.0/24", "used_memory" : 2, "security_group_name" : "securityGroupId", "instance_backup_policy" : null, "az_codes" : [ "xx-xxxxx-xx" ], "available_zones" : [ "d539378ec1314c85b76fefa3f7071458" ], "access_user" : null, "enterprise_project_id" : "0", "instance_id" : "a4c545cd-10b2-4efc-b0ab-a9b554ca0621", "enable_publicip" : false, "port" : 6379, "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", "domain_name" : "redis-a4c545cd-10b2-4efc-b0ab-a9b554ca0621.dcs.example.com", "name" : "dcs-billing", "spec_code" : "redis.ha.xu1.tiny.r2.128", "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af", "engine_version" : "5.0", "order_id" : null, "status" : "RUNNING", "features" : { "support_acl" : true, "support_transparent_client_ip" : true, "support_ssl" : false, "support_audit_log" : false }, "domain_name_info" : { "support_public_resolve" : true, "is_latest_rules" : true, "zone_name" : "dcs.example.com", "history_domain_names" : null }, "transparent_client_ip_enable" : true, "sub_status" : "normal", "cpu_type" : "x86_64", "cloud_service_type_code" : "hws.service.type.dcs", "cloud_resource_type_code" : "hws.resource.type.dcs3", "inquery_spec_code" : "redis.ha.xu1.tiny.r2.128", "free" : null, "is_free" : null, "libos" : false, "crr_role" : null, "active_active" : null, "task" : "EXTENDING", "proxy_links" : null }
Status Codes
Status Code |
Description |
---|---|
200 |
The specified instance is queried successfully. |
400 |
Invalid request. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.