Increasing Instance Specifications
Function
This API is used to modify instance specifications.
This API is out-of-date and may not be maintained in the future. Please use the API described in Increasing Instance Specifications.
URI
POST /v2/{project_id}/instances/{instance_id}/extend
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. |
instance_id | Yes | String | Instance ID. |
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
new_spec_code | No | String | Specification ID after the change. If only the disk size is expanded, the specification ID remains unchanged. |
new_storage_space | No | Integer | Message storage space in GB after the change. If the bandwidth is expanded, new_storage_space cannot be smaller than the minimum disk size specified by the bandwidth. |
oper_type | No | String | Type of the increase. The new specifications support the following types: horizontal, vertical, node, and storage. |
new_broker_num | No | Integer | Number of cluster nodes after the specifications are changed. |
new_product_id | No | String | Product ID after the specifications are changed. This parameter must be specified for vertical expansion (scale-up). You can obtain the product ID from Querying Product Specifications. |
publicip_id | No | String | ID of the elastic IP address (EIP) bound to an instance. Use commas (,) to separate multiple EIP IDs. To increase specifications when public access is enabled, this parameter is mandatory. |
tenant_ips | No | Array of strings | To create a broker, the IPv4 private IP addresses of the broker can be manually specified. The addresses must be within the amount of the broker. If the number of specified private IP addresses is less than the number of purchased brokers, unspecified brokers are randomly assigned private IP addresses. |
second_tenant_subnet_id | No | String | To increase instance specifications, new brokers use the ID of the subnet. This value is transferred when a standby subnet is used in instance expansion. Contact customer service to use the value. |
Response Parameters
Status code: 200
Parameter | Type | Description |
---|---|---|
job_id | String | ID of the specification modification task. |
Example Request
Expansion of a pay-per-use instance (old specifications)
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/extend{"new_spec_code" : "dms.instance.kafka.cluster.c3.mini","new_storage_space" : 1000}
Example Response
Status code: 200
The instance expansion task is submitted.
{"job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"}
Status Code
Status Code | Description |
---|---|
200 | The instance expansion task is submitted. |
Error Codes
See Error Codes.
- Function
- URI
- Request Parameters
- Response Parameters
- Example Request
- Example Response
- Status Code
- Error Codes