Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Scaling Out a DDM Instance
Updated on 2024-08-02 GMT+08:00
View PDF
Share

Scaling Out a DDM Instance

Function

This API is used to scale out a specified DDM instance. Pay-per-use and yearly/monthly instances are all supported.

Constraints

Make sure that the associated RDS instances are 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

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.
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

group_id

No

String

Group ID, which specifies the group that is scaled out. This parameter must be specified if there are more than one node group.

is_auto_pay

No

Boolean

Whether the order is automatically paid when you change the node class of a yearly/monthly instance. This parameter does not affect the billing mode of automatic renewal.

  • true: indicates that the order is automatically paid from the account.
  • false: indicates that the order is manually paid from the account. The default value is false.

available_zones

No

Array of strings

AZ code. This parameter is valid only for yearly/monthly instances. The number of AZs must be same as that specified in node_number. For details, see Regions and Endpoints.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instanceId

String

DDM instance ID

instanceName

String

DDM instance name. This parameter is returned only for pay-per-use instances.

jobId

String

Task ID. This parameter is returned only for pay-per-use instances.

orderId

String

Order ID. This parameter is returned only for yearly/monthly instances.

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

  • Scaling out a pay-per-use DDM instance. The number of nodes to be added is 1. 
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

{
  "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
  "node_number" : 1
}
  • Scaling out a pay-per-use DDM instance that has more than one group. The number of nodes to be added is 1. 
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

{
  "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
  "group_id" : "f080abf2010d45118068c28c8958f5fcgr09",
  "node_number" : 1
}
  • Scaling out a yearly/monthly DDM instance. The number of nodes to be added is 1 and the order is paid from your account balance. 
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

{
  "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
  "node_number" : 1,
  "is_auto_pay" : true,
  "available_zones": [
	"az1xahz"
  ]
}

Example Response

Status code: 200

ok

{ 
  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09", 
  "instanceName" : "ddm-fb88-test", 
  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
}

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