Querying Product Information for Instance Specification Modification
Function
This API is used to query the product information for instance specification modification.
URI
GET /v2/{engine}/{project_id}/instances/{instance_id}/extend
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
engine |
Yes |
String |
Message engine, which is rocketmq. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
No |
String |
Type of a product. advanced: DMS for RocketMQ |
limit |
No |
Integer |
Number of records to be queried. |
offset |
No |
Integer |
Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Number |
Total. |
next_offset |
Integer |
Offset of the next page. |
previous_offset |
Integer |
Offset of the previous page. |
engine |
String |
Message engine. |
versions |
Array of strings |
Versions supported by the message engine. |
products |
Array of RocketMQExtendProductInfoEntity objects |
Product information for specification modification. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Instance type. |
product_id |
String |
Product ID. |
ecs_flavor_id |
String |
ECS flavor used by the product. |
billing_code |
String |
Billing mode. |
arch_types |
Array of strings |
Supported CPU architectures. |
charging_mode |
Array of strings |
Supported billing modes. |
ios |
Array of RocketMQExtendProductIosEntity objects |
Disk I/O information. |
properties |
Key-value pair of a feature. |
|
available_zones |
Array of strings |
AZs where there are available resources. |
unavailable_zones |
Array of strings |
AZs where resources are sold out. |
support_features |
Array of RocketMQProductSupportFeaturesEntity objects |
Supported features. |
qingtian_incompatible |
Boolean |
Indicates whether the instance is a QingTian instance. |
Parameter |
Type |
Description |
---|---|---|
io_spec |
String |
Storage I/O specification. |
available_zones |
Array of strings |
AZs where there are available resources. |
type |
String |
I/O type. |
unavailable_zones |
Array of strings |
AZs where resources are sold out. |
Parameter |
Type |
Description |
---|---|---|
max_broker |
String |
Maximum number of brokers. |
max_topic_per_broker |
String |
Maximum number of topics that can be created on each broker. |
max_consumer_per_broker |
String |
Maximum number of consumers of each broker. |
max_storage_per_node |
String |
Maximum storage space of each broker. Unit: GB. |
min_broker |
String |
Minimum number of brokers. |
engine_versions |
String |
Version of the message engine. |
min_storage_per_node |
String |
Minimum storage space of each broker. The unit is GB. |
product_alias |
String |
Alias of product_id. |
Example Requests
Querying the product information for instance modification
GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend
Example Responses
Status code: 200
Product information for instance specification modification queried.
{ "total" : 1, "next_offset" : -1, "previous_offset" : -1, "engine" : "rocketmq", "versions" : [ "4.8.0" ], "products" : [ { "type" : "cluster.small", "product_id" : "c6.4u8g.cluster.small", "ecs_flavor_id" : "c6.xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "2", "max_topic_per_broker" : "2000", "max_storage_per_node" : "30000", "max_consumer_per_broker" : "2000", "min_broker" : "1", "product_alias" : "rocketmq.4u8g.cluster.small", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.4u8g.cluster", "ecs_flavor_id" : "s6.xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "4000", "max_storage_per_node" : "60000", "max_consumer_per_broker" : "4000", "min_broker" : "1", "product_alias" : "rocketmq.4u8g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.8u16g.cluster", "ecs_flavor_id" : "c6s.2xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "8000", "max_storage_per_node" : "90000", "max_consumer_per_broker" : "8000", "min_broker" : "1", "product_alias" : "rocketmq.8u16g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.12u24g.cluster", "ecs_flavor_id" : "c6s.3xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "12000", "max_storage_per_node" : "90000", "max_consumer_per_broker" : "12000", "min_broker" : "1", "product_alias" : "rocketmq.12u24g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false }, { "type" : "cluster", "product_id" : "c6.16u32g.cluster", "ecs_flavor_id" : "c6.4xlarge.2", "billing_code" : "dms.platinum.c6", "arch_types" : [ "X86" ], "charging_mode" : [ "monthly", "hourly" ], "ios" : [ { "io_spec" : "dms.physical.storage.high.v2", "available_zones" : [ "xxx" ], "type" : "evs", "unavailable_zones" : [ "xxx" ] }, { "io_spec" : "dms.physical.storage.ultra.v2", "available_zones" : [ ], "type" : "evs", "unavailable_zones" : [ "xxx" ] } ], "support_features" : [ ], "properties" : { "max_broker" : "10", "max_topic_per_broker" : "16000", "max_storage_per_node" : "90000", "max_consumer_per_broker" : "16000", "min_broker" : "1", "product_alias" : "rocketmq.16u32g.cluster", "engine_versions" : "4.8.0", "min_storage_per_node" : "300" }, "available_zones" : [ "xxx" ], "unavailable_zones" : [ "xxx" ], "qingtian_incompatible" : false } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Product information for instance specification modification queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.