Querying Product Information for Instance Specification Modification
Function
This API is used to query the product information for instance specification modification.
Debugging
You can use API Explorer to debug this API.
URI
GET /v2/{project_id}/instances/{instance_id}/extend
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| instance_id | Yes | String | Instance ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | Yes | String | Product edition.
|
| engine | No | String | Message engine. Currently supported: kafka. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| hourly | Array of hourly objects | List of pay-per-use products. |
| monthly | Array of monthly objects | List of products in yearly/monthly billing mode. Currently, you cannot create yearly/monthly billing Kafka instances by calling APIs. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Message engine, which is kafka. |
| version | String | Version of the message engine. Currently, only 1.1.0 and 2.3.0 is supported. |
| values | Array of values objects | Product specifications. |
| Parameter | Type | Description |
|---|---|---|
| detail | Array of detail objects | Specification details. |
| name | String | Instance type. |
| unavailable_zones | Array of strings | AZs where resources are sold out. |
| available_zones | Array of strings | List of AZs where there are available resources. |
| Parameter | Type | Description |
|---|---|---|
| tps | String | Maximum number of messages per unit time. |
| storage | String | Message storage space. |
| partition_num | String | Number of partitions in a Kafka instance. |
| product_id | String | Product ID. |
| spec_code | String | Specification ID. |
| io | Array of io objects | I/O information. |
| bandwidth | String | Bandwidth of a Kafka instance. |
| unavailable_zones | Array of strings | AZs where resources are sold out. |
| available_zones | Array of strings | List of AZs where there are available resources. |
| ecs_flavor_id | String | Flavors of the corresponding ECS. |
| arch_type | String | Instance architecture type. Currently, only x86 is supported. |
| Parameter | Type | Description |
|---|---|---|
| io_type | String | I/O type. |
| storage_spec_code | String | I/O specifications. |
| available_zones | Array of strings | List of AZs where there are available I/O resources. |
| unavailable_zones | Array of strings | List of AZs where I/O resources are sold out. |
| volume_type | String | Disk type. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Message engine, which is kafka. |
| version | String | Version of the message engine. Currently, only 1.1.0 and 2.3.0 is supported. |
| values | Array of values objects | Product specifications. |
| Parameter | Type | Description |
|---|---|---|
| detail | Array of detail objects | Specification details. |
| name | String | Instance type. |
| unavailable_zones | Array of strings | AZs where resources are sold out. |
| available_zones | Array of strings | List of AZs where there are available resources. |
| Parameter | Type | Description |
|---|---|---|
| tps | String | Maximum number of messages per unit time. |
| storage | String | Message storage space. |
| partition_num | String | Number of partitions in a Kafka instance. |
| product_id | String | Product ID. |
| spec_code | String | Specification ID. |
| io | Array of io objects | I/O information. |
| bandwidth | String | Bandwidth of a Kafka instance. |
| unavailable_zones | Array of strings | AZs where resources are sold out. |
| available_zones | Array of strings | List of AZs where there are available resources. |
| ecs_flavor_id | String | Flavors of the corresponding ECS. |
| arch_type | String | Instance architecture type. Currently, only x86 is supported. |
| Parameter | Type | Description |
|---|---|---|
| io_type | String | I/O type. |
| storage_spec_code | String | I/O specifications. |
| available_zones | Array of strings | List of AZs where there are available I/O resources. |
| unavailable_zones | Array of strings | List of AZs where I/O resources are sold out. |
| volume_type | String | Disk type. |
Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/extend?type={type}&engine={engine} Example Responses
Status code: 200
The query is successful.
{
"Hourly" : [ {
"name" : "kafka",
"version" : "1.1.0",
"values" : [ {
"detail" : [ {
"tps" : "50000",
"storage" : "200",
"partition_num" : "300",
"product_id" : "00300-30316-0--0",
"spec_code" : "kafka.c3.mini.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "100MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.large.2",
"arch_type" : "X86"
}, {
"tps" : "100000",
"storage" : "396",
"partition_num" : "900",
"product_id" : "00300-30340-0--0",
"spec_code" : "kafka.c3.small.2.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "300MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.xlarge.2",
"arch_type" : "X86"
}, {
"tps" : "200000",
"storage" : "1056",
"partition_num" : "1800",
"product_id" : "00300-30342-0--0",
"spec_code" : "kafka.c3.middle.2.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "600MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.2xlarge.2",
"arch_type" : "X86"
}, {
"tps" : "300000",
"storage" : "2112",
"partition_num" : "1800",
"product_id" : "00300-30344-0--0",
"spec_code" : "kafka.c3.high.2.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "1200MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.2xlarge.2",
"arch_type" : "X86"
} ],
"name" : "cluster",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ]
} ]
} ],
"Monthly" : [ {
"name" : "kafka",
"version" : "1.1.0",
"values" : [ {
"detail" : [ {
"tps" : "50000",
"storage" : "200",
"partition_num" : "300",
"product_id" : "00300-30317-0--0",
"spec_code" : "kafka.c3.mini.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "100MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.large.2",
"arch_type" : "X86"
}, {
"tps" : "100000",
"storage" : "396",
"partition_num" : "900",
"product_id" : "00300-30341-0--0",
"spec_code" : "kafka.c3.small.2.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "300MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.xlarge.2",
"arch_type" : "X86"
}, {
"tps" : "200000",
"storage" : "1056",
"partition_num" : "1800",
"product_id" : "00300-30343-0--0",
"spec_code" : "kafka.c3.middle.2.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "600MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.2xlarge.2",
"arch_type" : "X86"
}, {
"tps" : "300000",
"storage" : "2112",
"partition_num" : "1800",
"product_id" : "00300-30345-0--0",
"spec_code" : "kafka.c3.high.2.connector",
"io" : [ {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"available_zones" : [ "cn-north-4d", "cn-north-4b", "cn-north-4g", "cn-north-4e", "cn-north-4f", "cn-north-4c", "cn-north-4a" ],
"volume_type" : "SSD"
} ],
"bandwidth" : "1200MB",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ],
"ecs_flavor_id" : "c6.2xlarge.2",
"arch_type" : "X86"
} ],
"name" : "cluster",
"unavailable_zones" : [ "cn-north-4c", "cn-north-4d", "cn-north-4e", "cn-north-4f", "cn-north-4g" ],
"available_zones" : [ "cn-north-4b", "cn-north-4a" ]
} ]
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The query is successful. |
Error Codes
See Error Codes.
Last Article: Specification Modification Management
Next Article: Modifying Instance Specifications
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.