Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Synchronizing Data Node Information
Updated on 2024-08-02 GMT+08:00
View PDF
Share

Synchronizing Data Node Information

Function

This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.

Constraints

None

URI

POST /v1/{project_id}/instances/{instance_id}/rds/sync

Table 1 Path 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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instanceId

String

DDM instance ID

jobId

String

Task ID

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

Synchronizing data node information

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds/sync

None

Example Response

Status code: 200

OK

{
  "instanceId" : "1f5c9fd6cd984056ba89c8c87cc03278in09",
  "jobId" : "6f1334ca-faa6-479e-837f-f3219192675e"
}

Status code: 400

bad request

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

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances