Querying an Instance

Function

This API is used to query details about a single instance.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
configuration_status	String	Definition: Configuration status. Range: In-Sync: The application is complete. Applying: The policy is being applied. Pending-Reboot: The configuration takes effect after the system is restarted. Sync-Failure: The modification fails.
params_group_id	String	Definition Parameter template ID. Range N/A
type	String	Definition: Type. Range: dws-cn: CN node. dws: DN node. cms: CMS node. gtm: GTM node. vw: VW node.
subnet_id	String	Definition Subnet ID. Range N/A
role	String	Definition Role. Range N/A
internal_subnet_id	String	Definition Internal subnet ID. Range N/A
group	String	Definition Group information. Range N/A
secure_group	String	Definition Security group. Range N/A
vpc	String	Definition VPC ID. Range N/A
azcode	String	Definition AZ code. Range N/A
region	String	Definition Region code. Range N/A
cluster_id	String	Definition Cluster ID. Range N/A
created	String	Definition Creation time. Range N/A
updated	String	Definition Update time. Range N/A
status	String	Definition: Status. Range: BUILD: The instance is being created. ACTIVE: available FAILED: unavailable DELETED: The instance has been deleted. REBOOTING: The instance is being restarted. ERROR: The creation fails. SHUTDOWN: shut down
name	String	Definition Node name. Range N/A
links	Array of LinkResp objects	Definition Link information. Range N/A
id	String	Definition Node ID. Range N/A
flavor	ClusterFlavorResp object	Definition Flavor information. Range N/A
volume	CompatibleInstanceVolumeResp object	Definition Capacity. Range N/A
datastore	CompatibleDataStoreResp object	Definition Version information. Range N/A
fault	CompatibleFaultResp object	Definition Others. Range N/A
configuration	CompatibleConfigurationResp object	Definition Parameter configurations. Range N/A
locality	String	Definition This parameter has been deprecated and has no actual meaning. Range N/A
replicas	Array of CompatibleReplicasResp objects	Definition This parameter has been deprecated and has no actual meaning. Range N/A
db_user	String	Definition Database user. Range N/A
storage_engine	String	Definition Storage engine. Range N/A
pay_model	Integer	Definition Payment method. Range N/A
public_ip	String	Definition Public IP address. Range N/A
traffic_ip	String	Definition Traffic IP address. Range N/A

**Table 3** ClusterFlavorResp
Parameter	Type	Description
id	String	Definition Flavor ID. Range N/A
links	Array of LinkResp objects	Definition Link information. Range N/A

**Table 4** CompatibleInstanceVolumeResp
Parameter	Type	Description
type	String	Definition: Disk type. Range: SATA: common I/O SAS: high I/O SSD: ultra-high I/O ESSD: Extreme SSD GPSSD: general-purpose SSD
used	Float	Definition Used size. Range N/A
size	Integer	Definition Total size. Range N/A

**Table 5** CompatibleDataStoreResp
Parameter	Type	Description
type	String	Definition: Database type. Range: dws: cloud data warehouse hybrid: real-time data warehouse
version	String	Definition Version. Range N/A

**Table 6** CompatibleFaultResp
Parameter	Type	Description
message	String	Definition Messages. Range N/A
created	String	Definition Creator. Range N/A
details	String	Definition Details. Range N/A

**Table 7** CompatibleConfigurationResp
Parameter	Type	Description
id	String	Definition Parameter template ID. Range N/A
name	String	Definition Parameter template name. Range N/A
links	Array of LinkResp objects	Definition Connection information. Range N/A

**Table 8** CompatibleReplicasResp
Parameter	Type	Description
id	String	Definition ID. Range N/A
name	String	Definition Name. Range N/A
links	Array of LinkResp objects	Definition Link. Range N/A

**Table 9** LinkResp
Parameter	Type	Description
rel	String	Definition Associated information. Range N/A
href	String	Definition Link information. Range N/A

Example Requests

Query information about a single instance.

GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/instances/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90

Example Responses

Status code: 200

{
  "type" : "dws-cn",
  "role" : "Standalone",
  "group" : "cn-1",
  "vpc" : "28e65e71-0b08-4f04-a05f-1603f869cd1f",
  "azcode" : "cn-north-7c",
  "region" : "cn-north-7",
  "created" : "2025-05-11T10:07:06",
  "updated" : "2025-05-11T10:07:06",
  "status" : "ACTIVE",
  "name" : "dws-apie-dws-cn-cn-1-1",
  "links" : [ {
    "rel" : "self",
    "href" : ""
  }, {
    "rel" : "bookmark",
    "href" : ""
  } ],
  "id" : "a83ed6f4-8062-427f-81bc-1dd0546acb43",
  "flavor" : {
    "id" : "3228254e-81c6-4975-bb45-5d8365ab5f25",
    "links" : [ {
      "rel" : "self",
      "href" : ""
    }, {
      "rel" : "bookmark",
      "href" : ""
    } ]
  },
  "volume" : null,
  "datastore" : {
    "type" : "dws",
    "version" : "9.1.0.215"
  },
  "fault" : null,
  "configuration" : {
    "id" : "1fd0a140-c487-4b95-bf9a-243fe3d7468a",
    "name" : null,
    "links" : [ {
      "rel" : "self",
      "href" : ""
    }, {
      "rel" : "bookmark",
      "href" : ""
    } ]
  },
  "locality" : null,
  "replicas" : null,
  "configuration_status" : "In-Sync",
  "params_group_id" : "1fd0a140-c487-4b95-bf9a-243fe3d7468a",
  "subnet_id" : "b530bb2b-724b-477e-bd55-b4428ae91fdf",
  "internal_subnet_id" : "b37dceca-dec6-4128-8d57-abd0b6ce0cbe",
  "secure_group" : "cd15fdcd-c7d5-4660-bb78-30e701e80775",
  "cluster_id" : "bcdfb00c-a5e3-4896-83c7-3c397ed99f28",
  "db_user" : "dbadmin",
  "storage_engine" : null,
  "pay_model" : 0,
  "public_ip" : null,
  "traffic_ip" : "192.200.132.176"
}

Status Codes

Status Code	Description
200	Query succeeded.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.

Parent Topic: Node Change

Previous topic: Scaling Out a Cluster

Next topic: Querying Redistribution Details