Changing DB Instance Specifications¶

Function¶

This API is used to change DB instance specifications. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI¶

URI format
POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/action
Example
POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action
Parameter description
Table 1 Parameter description¶
Name
Type
Mandatory
Description
project_id
String
Yes
Project ID of a tenant in a region.
To obtain this value, see Obtaining a Project ID.
instance_id
String
No
DB instance ID.

**Table 1** Parameter description¶
Name	Type	Mandatory	Description
project_id	String	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	String	No	DB instance ID.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token.
X-Language	No	String	Language.
Content-Type	Yes	String	MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
resize_flavor	Yes	MysqlResizeFlavor object	Specification change information.

**Table 4** MysqlResizeFlavor¶
Parameter	Mandatory	Type	Description
spec_code	Yes	String	Specification code.

Response Parameters¶

Status code: 200

**Table 5** Response body parameters¶
Parameter	Type	Description
job_id	String	Job ID for changing DB instance specifications. This parameter is returned only when you change the specifications of a pay-per-use DB instance.
order_id	String	Order ID for changing DB instance specifications. This parameter is returned only when you change the specification of a yearly/monthly DB instance.

Status code: 400

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request¶

Changing instance specifications

POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action
{
  "resize_flavor" : {
    "spec_code" : "taurus.large.4"
  }
}

Example Response¶

None

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-11-13 14:30 UTC - commit: 805f4aa7e58669fc866d3eb0c4241508900e849d