Creating an Instance
Function
This API is used to create an instance.

This API is out-of-date and may not be maintained in the future. Please use the API described in Creating an Instance.
URI
POST /v2/{engine}/{project_id}/instances
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
engine |
Yes |
String |
Message engine. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
Request
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. 0 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 |
Message engine. Set the value to kafka. |
engine_version |
Yes |
String |
Version of the engine. Values:
|
broker_num |
Yes |
Integer |
Number of brokers. |
storage_space |
Yes |
Integer |
Message storage space, in GB.
|
access_user |
No |
String |
This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false. A username must start with a letter and only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain 4 to 64 characters. |
password |
No |
String |
This parameter is mandatory when ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false. Instance password. The password must meet the following complexity requirements:
|
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. |
security_group_id |
Yes |
String |
Security group which the instance belongs to. 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. |
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. |
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 Listing AZ Information. This parameter cannot be empty or null. When creating a Kafka instance, you can select either 1 AZ or at least 3 AZ. When specifying AZs for brokers, use commas (,) to separate multiple AZs. |
product_id |
Yes |
String |
Product ID. You can obtain the product ID from Querying Product Specifications. |
maintain_begin |
No |
String |
Time at which the maintenance time window starts. Format: HH:mm. |
maintain_end |
No |
String |
Time at which the maintenance time window ends. Format: HH:mm. |
enable_publicip |
No |
Boolean |
Whether to enable public access.
|
publicip_id |
No |
String |
ID of the elastic IP address (EIP) bound to an 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). |
ssl_enable |
No |
Boolean |
Whether to enable SSL-encrypted access. This setting is fixed once the instance is created.
|
kafka_security_protocol |
No |
String |
Security protocol to use after SASL is enabled. This parameter is mandatory if SASL authentication is enabled (that is, when ssl_enable is set to true). If this parameter is left blank, SASL_SSL authentication is enabled by default. This setting is fixed once the instance is created.
|
sasl_enabled_mechanisms |
No |
Array of strings |
Authentication mechanism to use after SASL is enabled. This parameter is mandatory if SASL authentication is enabled (that is, when ssl_enable is set to true). If this parameter is left blank, PLAIN authentication is enabled by default. Select both or either of the following mechanisms. Options:
|
retention_policy |
No |
String |
Action to be taken when the memory usage reaches the disk capacity threshold. Values:
|
ipv6_enable |
No |
Boolean |
Indicates whether IPv6 is enabled. This parameter is available only when the VPC supports IPv6. |
disk_encrypted_enable |
No |
Boolean |
Indicates whether to enable disk encryption. |
disk_encrypted_key |
No |
String |
Disk encryption key. If disk encryption is not enabled, this parameter is left blank. |
enable_auto_topic |
No |
Boolean |
Indicates whether to enable automatic topic creation.
If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist. The default value is false. |
storage_spec_code |
Yes |
String |
Storage I/O specification. Values:
For details about selecting a disk type, see "Disk Types and Disk Performance" in Elastic Volume Service User Guide. |
enterprise_project_id |
No |
String |
Enterprise project ID. This parameter is mandatory for an enterprise project account. |
tags |
No |
Array of TagEntity objects |
List of tags. |
arch_type |
No |
String |
CPU architecture. Values:
|
vpc_client_plain |
No |
Boolean |
Private plaintext access in a VPC. |
bss_param |
No |
BssParam object |
Parameter related to the yearly/monthly billing mode. If this parameter is left blank, the billing mode is pay-per-use by default. If this parameter is not left blank, the billing mode is yearly/monthly. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Tag key, which:
|
value |
No |
String |
Tag value.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_auto_renew |
No |
Boolean |
Indicates whether auto-renewal is enabled. Values:
By default, auto renewal is disabled. |
charging_mode |
No |
String |
Billing mode. Values:
The default value is postPaid. |
is_auto_pay |
No |
Boolean |
Specifies whether the order is automatically or manually paid. Values:
The default value is false. |
period_type |
No |
String |
Subscription period Values:
This parameter is valid and mandatory when chargingMode is set to prePaid. |
period_num |
No |
Integer |
Number of subscription periods. Values:
This parameter is valid and mandatory when chargingMode is set to prePaid. |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Instance ID. |
Example Request
Creating a pay-per-use Kafka instance whose version is 2.7, specifications are 2 vCPUs | 4 GB × 3, and storage space is 300 GB
POST https://{endpoint}/v2/{engine}/{project_id}/instances { "name" : "kafka-test", "description" : "", "engine" : "kafka", "engine_version" : "2.7,3.x", "storage_space" : 300, "vpc_id" : "********-9b4a-44c5-a964-************", "subnet_id" : "********-8fbf-4438-ba71-************", "security_group_id" : "********-e073-4aad-991f-************", "available_zones" : [ "********706d4c1fb0eb72f0********" ], "product_id" : "c6.2u4g.cluster", "ssl_enable" : true, "kafka_security_protocol" : "SASL_SSL", "sasl_enabled_mechanisms" : [ "SCRAM-SHA-512" ], "storage_spec_code" : "dms.physical.storage.ultra.v2", "broker_num" : 3, "arch_type" : "X86", "enterprise_project_id" : "0", "access_user" : "********", "password" : "********", "enable_publicip" : true, "tags" : [ { "key" : "aaa", "value" : "111" } ], "retention_policy" : "time_base", "disk_encrypted_enable" : true, "disk_encrypted_key" : "********-b953-4875-a743-************", "publicip_id" : "********-88fc-4a8c-86d0-************,********-16af-455d-8d54-************,********-3d69-4367-95ab-************", "vpc_client_plain" : true, "enable_auto_topic" : true }
Example Response
Status code: 200
Instance created successfully.
{ "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" }
Status Code
Status Code |
Description |
---|---|
200 |
Instance created successfully. |
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot