Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ DDM Instance Management/ Synchronizing DB Instance Data
Updated on 2022-08-17 GMT+08:00
View PDF
Share

Synchronizing DB Instance Data

Function

This API is used to synchronize configuration information of all DB instances that are associated with the current 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

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

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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

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

Example Response

Status code: 200

ok

{
    "instanceId": "c820883c241dxxxxa5d9xxxxdeb7d487in09",
    "jobId": "175f5aff-xxxx-xxxx-xxxx-d0858982bbec"
}

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instance Management