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
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
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 node 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 your account. false: indicates that the order is manually paid from your account. The default value is false. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instanceId |
String |
DDM instance ID |
instanceName |
String |
DDM instance name |
jobId |
String |
Task ID |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Example Request
- Example request 1
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge { "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", "node_number" : 1 }
- Example request 2: Scaling out a DDM instance that has more than one group
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge { "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", "group_id" : "f080abf2010d45118068c28c8958f5fcgr09", "node_number" : 1 }
- Example request 3: Scaling out a yearly/monthly instance for which parameter is_auto_pay is set to true
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 }
Example Response
Status code: 200
ok
{ "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09", "instanceName" : "BUG-ddm-fb88-test", "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9", "orderId": null, "securityGroupId": null }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot