Querying DDM Instances

This API is used to query DDM instances.

None

GET /v1/{project_id}/instances

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Number of records displayed on each page. The start value cannot be less than 0. Minimum value: 0
limit	Yes	Integer	Number of records on each page. The value is greater than 0 and less than or equal to 128. Minimum value: 1 Maximum value: 128

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
instances	Array of ShowDDMInstanceResponse objects	DDM instance information
instance_num	Integer	Number of DDM instances of a tenant
page_no	Integer	Current page number
page_size	Integer	Number of data records on the current page
total_record	Integer	Total number of data records
total_page	Integer	Total number of pages

**Table 5** Parameters for querying DDM Instances
Parameter	Type	Description
id	String	DDM instance ID
status	String	DDM instance status
name	String	Name of the created DDM instance
created	String	Time when the schema is created
updated	String	Indicates the updated time, which is the same format as created.
available_zone	String	AZ name
vpc_id	String	VPC ID
subnet_id	String	Subnet ID
security_group_id	String	Security group ID
node_count	Integer	Number of nodes
access_ip	String	Address for accessing the DDM instance
access_port	String	Port for accessing the DDM instance
core_count	String	Number of CPUs
ram_capacity	String	Memory size in GB
error_msg	String	Response message. This parameter is not returned if no error occurs.
node_status	String	Node status
enterprise_project_id	String	Enterprise project ID
project_id	String	Project ID of a tenant in a region
engine_version	String	Engine version (core version)

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

GET https://{endpoint}/v1/{project_id}/instances?offset={offset}&limit={limit}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: DDM Instance Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.