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

Scaling Out a DDM instance

Function

This API is used to add nodes to a specified DDM instance.

Constraints

Make sure that the associated RDS DB instance is available and not undergoing other operations.

URI

POST /v2/{project_id}/instances/{instance_id}/action/enlarge
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).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

flavor_id

Yes

String

Flavor ID of the VM for deploying the DDM instance that is to be scaled out

node_number

Yes

Integer

Number of nodes to be added

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instanceId

String

DDM instance ID

instanceName

String

DDM instance name

jobId

String

Task ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

Example Response

Status code: 200

ok

{
    "instanceId": "0d548585363e454b9e569b0a8d15565fin09",
    "instanceName": "ddm-d5e5",
    "jobId": "f56df2d7-0bb9-4546-af82-fef2bc606b2f"
}

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