Scaling In a DDM instance¶

Function¶

This API is used to remove nodes from a specified DDM instance.

Constraints¶

Make sure that the associated RDS instances are available and not undergoing other operations.

URI¶

POST /v2/{project_id}/instances/{instance_id}/action/reduce

**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 an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
node_number	Yes	Integer	Number of nodes to be removed. The maximum value is the instance nodes minus 1.
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.

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¶

Example request

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

{
  "node_number" : 2
}

Example request where the DDM instance has more than one group

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

{
  "group_id" : "f080abf2010d45118068c28c8958f5fcgr09",
  "node_number" : 1
}

Example Response¶

Status code: 200

{
  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
  "instanceName" : "ddm-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.

last updated: 2024-12-11 13:43 UTC - commit: 0e04c4a111cf440cbe530f17da84f5c1ac074d8f