Querying Data Nodes Available for Creating a Schema (a V3 API)

Function

This API is used to query data nodes available for creating a schema.

URI

GET /v3/{project_id}/instances/{instance_id}/available-data-nodes

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value is 0 by default. The value must be a non-negative number.
limit	No	Integer	Maximum records to be queried. Value range: 1 to 128 If the parameter value is not specified, 10 records are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data_nodes	Array of AvailableDnInstance objects	Available backend data nodes.
offset	Integer	Which page the server starts returning items
limit	Integer	Number of records displayed on each page
total	Integer	Total number of records

**Table 5** AvailableDnInstance
Parameter	Type	Description
id	String	Data node ID.
status	String	Data node status.
name	String	Data node name.
engine_name	String	Data node engine name.
engine_version	String	Data node engine version.
private_ip	String	Private IP address of the data node.
port	Integer	Port of the data node.
time_zone	String	Time zone of the data node.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Request

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/available-data-nodes?offset=0&limit=10

Example Response

Status code: 200

{
 "data_nodes": [
  {
   "id": "085ef55*****d1c9770fa92413a8822in01",
   "status": "normal",
   "name": "rds-f2f2",
   "engine_name": "mysql",
   "engine_version": "8.0",
   "private_ip": "127.0.0.1",
   "port": 3306,
   "time_zone": "UTC+08:00"
  }
 ],
 "offset": 0,
 "limit": 10,
 "total": 1
}

Status code: 400

Bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status code: 500

Server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status Codes

Status Codes	Description
200	OK
400	Bad request
500	Server error

Error Codes

For details, see Error Codes.

Parent topic: Schemas

Previous topic: Importing Schema Metadata (a V3 API)

Next topic: Querying Data Nodes Available for Shard Configuration (a V3 API)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

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

Chatbot