Query a Specified Instance in a Cluster

Function

This API is used to query a specified instance in a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1.1/{project_id}/instances/{instance_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
instance_id	Yes	String	Instance ID. For details about how to obtain it, see Querying the Cluster List.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
instance	CdmQueryClusterInstanceDetail object	Instance information

**Table 4** CdmQueryClusterInstanceDetail
Parameter	Type	Description
configurationStatus	String	Cluster configuration status. The options are as follows: In-Sync: The configuration has been synchronized. Applying: The cluster is being configured. Sync-Failure: The configuration failed.
paramsGroupId	String	Configuration ID
type	String	Service type, which is cdm
role	String	Instance mode, which is Standalone
subnetid	String	Subnet ID of the instance
securegroup	String	Security group ID
vpc	String	VPC ID of the instance
azcode	String	AZ name
region	String	Site name
created	String	Instance creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
updated	String	Instance update time in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
name	String	Instance name
id	String	Instance ID
flavor	flavor object	VM flavor of a node. For details, see the descriptions of flavor parameters.
datastore	Datastore object	Cluster information. For details, see the descriptions of datastore parameters.
dbuser	String	Database user, which is cdm
payModel	Integer	Payment mode 0: pay-per-use 1: yearly/monthly
publicIp	String	Public IP address bound to the cluster
trafficIp	String	Private IP address of the cluster
trafficIpv6	String	Private IPv6 address of the cluster
cluster_id	String	Cluster ID

**Table 5** flavor
Parameter	Type	Description
id	String	VM flavor ID
links	Array of ClusterLinks objects	Links

**Table 6** ClusterLinks
Parameter	Type	Description
rel	String	Relationship
href	String	Link address

**Table 7** Datastore
Parameter	Type	Description
type	String	Type. Generally, the value is cdm.
version	String	Cluster version

Example Requests

GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/instances/2c529048-ed06-4bcb-a48e-bf1800e1f496

Example Responses

Status code: 200

Request succeeded.

{
  "instance" : {
    "configurationStatus" : "In-Sync",
    "paramsGroupId" : "26084bb9-e74b-47d5-8be6-c0fbee9449d5",
    "type" : "cdm",
    "subnetid" : "9e4049b5-19a6-48fe-b5a2-2857c842fe56",
    "securegroup" : "560a3642-ddb1-4e93-a4bb-e484ae975127",
    "vpc" : "f35aee01-c4a3-47c1-8d92-9df430537de4",
    "azcode" : "xxx-xxx-xxxa",
    "region" : "xxx-xxx-xxx",
    "created" : "2018-09-05T08:38:25",
    "updated" : "2018-09-05T08:38:25",
    "name" : "test-cdm-dn-1-1",
    "id" : "2c529048-ed06-4bcb-a48e-bf1800e1f496",
    "flavor" : {
      "id" : "a79fd5ae-1833-448a-88e8-3ea2b913e1f6",
      "links" : [ ]
    },
    "datastore" : {
      "type" : "cdm",
      "version" : "2.9.3.300"
    },
    "dbuser" : "cdm",
    "payModel" : 0,
    "publicIp" : "49.xx.xx.10",
    "trafficIp" : "192.168.0.128",
    "trafficIpv6" : null,
    "cluster_id" : "2d9ac57e-3ebf-4557-86d5-89ae750ff61c"
  }
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Request error.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	Internal service error. For details about the returned error code, see Error Codes.
503	Service unavailable.