Creating a Pay-per-Use Instance
Function
This API is used to create a pay-per-use instance.
URI
POST /v2/{project_id}/instances
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
Instance name. An instance name starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-). |
|
description |
No |
String |
Description of an instance. The description supports up to 1024 characters.
NOTE:
The backslash () and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character () before the characters, for example, \ and ".
|
|
engine |
Yes |
String |
Definition Message engine type. Range
|
|
engine_version |
Yes |
String |
Message engine version. Set this parameter to 4.8.05.x. |
|
storage_space |
Yes |
Integer |
Definition Storage space, in GB. Range Different instance specifications support different storage configurations. |
|
vpc_id |
Yes |
String |
VPC ID. You can call the API for querying VPCs to obtain the VPC ID. The VPC ID is in the response body. For details, see Virtual Private Cloud API Reference. |
|
subnet_id |
Yes |
String |
Subnet information. You can call the API for querying subnets to obtain the subnet ID. The subnet ID is in the response body. For details, see Virtual Private Cloud API Reference. |
|
security_group_id |
Yes |
String |
Security group to which the instance belongs. You can call the API for querying security groups to obtain the security group ID. The security group ID is in the response body. For details, see Virtual Private Cloud API Reference. |
|
available_zones |
Yes |
Array of strings |
ID of the AZ where instance brokers reside and which has available resources. Obtain the AZ ID by referring to Querying AZ Information. The parameter value cannot be empty or null. Check whether resources exist in the AZs. During RocketMQ instance creation, brokers can be deployed in one AZ or three or more AZs. To specify AZs for brokers, separate AZs with commas (,). |
|
product_id |
Yes |
String |
Definition RocketMQ instance flavors. Constraints N/A Range
Default Value N/A |
|
ssl_enable |
No |
Boolean |
Whether to enable SSL encryption for access.
|
|
storage_spec_code |
Yes |
String |
Definition Storage I/O flavor. Range
|
|
enterprise_project_id |
No |
String |
Enterprise project ID. This parameter is mandatory for an enterprise project account. |
|
enable_acl |
No |
Boolean |
Definition Whether to enable access control. Constraints N/A Range
Default Value N/A |
|
ipv6_enable |
No |
Boolean |
Whether IPv6 is supported.
|
|
proxy_enable |
No |
Boolean |
Whether to enable the proxy function.
|
|
enable_publicip |
No |
Boolean |
Whether to enable public access. By default, public access is disabled.
|
|
disk_encrypted_enable |
No |
Boolean |
Whether disk encryption is enabled. |
|
disk_encrypted_key |
No |
String |
Disk encryption key. The value is blank when disk encryption is disabled. |
|
publicip_id |
No |
String |
ID of the EIP bound to the instance. Use commas (,) to separate multiple EIP IDs. This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true). |
|
broker_num |
Yes |
Integer |
Number of brokers. |
|
arch_type |
No |
String |
Definition Architecture type. Constraints N/A Range
Default Value N/A |
|
tls_mode |
No |
String |
Security protocol used by the instance. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
instance_id |
String |
Instance ID. |
Example Requests
Creating a pay-per-use instance
POST https://{endpoint}/v2/{project_id}/instances
{
"name" : "reliability-1751840557",
"description" : "",
"engine" : "reliability",
"engine_version" : "4.8.0",
"storage_space" : 600,
"vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
"subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
"security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
"available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
"product_id" : "c6.4u8g.cluster",
"enterprise_project_id" : "0",
"ssl_enable" : false,
"storage_spec_code" : "dms.physical.storage.ultra.v2",
"ipv6_enable" : false,
"enable_publicip" : false,
"publicip_id" : "",
"broker_num" : 1
}
Example Responses
Status code: 200
Instance created successfully.
{
"instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Instance created successfully. |
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.
