Querying Product Information for Instance Specification Modification (Old)

Function

This API is used to query the product information for instance specification modification.

This API is out-of-date and may not be maintained in the future. Please use the API described in Querying Product Information for Instance Specification Modification.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Type of a product. advanced: premium edition
engine	Yes	String	Message engine. Currently supported: kafka.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
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 Kafka instances by calling an API.

**Table 4** hourly
Parameter	Type	Description
name	String	Message engine, which is kafka.
version	String	Version of the engine.
values	Array of values objects	List of product specifications.

**Table 5** values
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	AZs where there are available resources.

**Table 6** detail
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.
recommend_max_consGroups	String	Recommended maximum number of consumer groups of a Kafka instance.
unavailable_zones	Array of strings	AZs where resources are sold out.
available_zones	Array of strings	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.

**Table 7** io
Parameter	Type	Description
io_type	String	I/O type.
storage_spec_code	String	I/O specification.
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.

**Table 8** monthly
Parameter	Type	Description
name	String	Message engine, which is kafka.
version	String	Version of the engine.
values	Array of values objects	List of product specifications.

**Table 9** values
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	AZs where there are available resources.

**Table 10** detail
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.
recommend_max_consGroups	String	Recommended maximum number of consumer groups of a Kafka instance.
unavailable_zones	Array of strings	AZs where resources are sold out.
available_zones	Array of strings	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.

**Table 11** io
Parameter	Type	Description
io_type	String	I/O type.
storage_spec_code	String	I/O specification.
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 Request

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/extend?type={type}&engine={engine}

Example Response

Status code: 200

Metrics queried successfully.

{
  "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "100MB",
        "recommend_max_consGroups" : "60",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "300MB",
        "recommend_max_consGroups" : "300",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "600MB",
        "recommend_max_consGroups" : "600",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "1200MB",
        "recommend_max_consGroups" : "600",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "ecs_flavor_id" : "c6.2xlarge.2",
        "arch_type" : "X86"
      } ],
      "name" : "cluster",
      "unavailable_zones" : [ "xxx", "xxx" ],
      "available_zones" : [ "xxx", "xxx" ]
    } ]
  } ],
  "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "100MB",
        "recommend_max_consGroups" : "60",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "300MB",
        "recommend_max_consGroups" : "300",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "600MB",
        "recommend_max_consGroups" : "600",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "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" : [ "xxx", "xxx" ],
          "volume_type" : "SAS"
        }, {
          "io_type" : "ultra",
          "storage_spec_code" : "dms.physical.storage.ultra",
          "available_zones" : [ "xxx", "xxx" ],
          "volume_type" : "SSD"
        } ],
        "bandwidth" : "1200MB",
        "recommend_max_consGroups" : "600",
        "unavailable_zones" : [ "xxx", "xxx" ],
        "available_zones" : [ "xxx", "xxx" ],
        "ecs_flavor_id" : "c6.2xlarge.2",
        "arch_type" : "X86"
      } ],
      "name" : "cluster",
      "unavailable_zones" : [ "xxx", "xxx" ],
      "available_zones" : [ "xxx", "xxx" ]
    } ]
  } ]
}