Help Center> Distributed Message Service for Kafka> API Reference> APIs V2 (Recommended)> Specification Modification Management> Modifying Instance Specifications
View PDF

Modifying Instance Specifications

Function

This API is used to modify instance specifications.

Currently, this API can only be used to modify specifications of pay-per-use instances.

Debugging

You can use API Explorer to debug this API.

URI

POST /v2/{project_id}/instances/{instance_id}/extend

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body 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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

ID of the specification modification task.

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/extend

{
  "new_spec_code" : "dms.instance.kafka.cluster.c3.mini",
  "new_storage_space" : 1000
}

Example Responses

Status code: 200

Instance specifications are modified successfully.

{
  "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"
}

Status Codes

Status Code

Description

200

Instance specifications are modified successfully.

Error Codes

See Error Codes.