Increasing Instance Specifications (New)
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/{engine}/{project_id}/instances/{instance_id}/extend
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| engine | Yes | String | Indicates the message engine. |
| 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 |
|---|---|---|---|
| oper_type | Yes | String | Operation type. Values:
|
| new_storage_space | No | Integer | New storage space. This parameter is valid and mandatory when oper_type is set to storage or horizontal. Instance storage space = Number of brokers × Storage space of each broker. If oper_type is set to storage, the number of brokers remains unchanged, and the storage space of each broker must be expanded by at least 100 GB. If oper_type is set to horizontal, the storage space of each broker remains unchanged. |
| new_broker_num | No | Integer | This parameter is valid only when oper_type is set to horizontal. |
| new_product_id | No | String | New product ID for scale-up. This parameter is valid and mandatory when oper_type is set to vertical. 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. This parameter is mandatory when oper_type is set to horizontal. |
| tenant_ips | No | Array of strings | Specified private IP address. Only IPv4. The number of specified IP addresses must be less than or equal to the number of new nodes. If the number of specified IP addresses is less than the number of nodes, private IP addresses are randomly allocated to the nodes that are not specified. |
| second_tenant_subnet_id | No | String | ID of the standby subnet used by new brokers during instance expansion. This value is transferred when a standby subnet is used during instance expansion. To transfer this value, submit a service ticketcontact customer service. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | ID of the specification modification task. |
Example Request
- Increasing the storage space (pay-per-use instance)
POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend { "oper_type" : "storage", "new_storage_space" : 600 } - Increasing brokers (pay-per-use instance)
POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend { "oper_type" : "horizontal", "new_storage_space" : 1600, "new_broker_num" : 4, "tenant_ips" : [ "127.0.0.1", "127.0.0.2", "127.0.0.3" ] } - Increasing the broker flavor (pay-per-use instance)
POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend { "oper_type" : "vertical", "new_product_id" : "c6.4u8g.cluster" }
Example Response
Status code: 200
Instance scaled.
{
"job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"
} Status Code
| Status Code | Description |
|---|---|
| 200 | Instance scaled. |
Error Code
See Error Codes.
What is your overall rating for this page?
Thank 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