Deploys an ApsaraMQ for Kafka instance. You must purchase and deploy an ApsaraMQ for Kafka instance before you can use the instance to send and receive messages.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
alikafka:StartInstance | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the instance. | alikafka_post-cn-v0h1fgs2**** |
RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
VpcId | string | Yes | The ID of the virtual private cloud (VPC) in which you want to deploy the instance. | vpc-bp1r4eg3yrxmygv**** |
VSwitchId | string | Yes | The ID of the vSwitch to which you want to connect the instance. | vsw-bp1j3sg5979fstnpl**** |
DeployModule | string | Yes | The deployment mode of the instance. Valid values:
The deployment mode of the instance must match the type of the instance. If the instance allows access only from a VPC, set the value to vpc. If the instance allows access from the Internet and a VPC, set the value to eip. | vpc |
ZoneId | string | No | The ID of the zone where you want to deploy the ApsaraMQ for Kafka instance.
Note
If resources in the specified zone is insufficient, the instance may be deployed in another zone.
| cn-hangzhou-k |
IsEipInner | boolean | No | Specifies whether the instance supports elastic IP addresses (EIPs). Valid values:
The value of this parameter must match the type of the instance. For example, if the instance allows access only from a VPC, set this parameter to false. | false |
IsSetUserAndPassword | boolean | No | Specifies whether to set a new username and password. Valid values:
This parameter is available only if you deploy an instance that allows access from the Internet and a VPC. | false |
Username | string | No | The username that is used to access the instance. This parameter is available only if you deploy an instance that allows access from the Internet and a VPC. | username |
Password | string | No | The password that corresponds to the username. This parameter is available only if you deploy an instance that allows access from the Internet and a VPC. | password |
Name | string | No | The name of the instance. Note
If you specify a value for this parameter, make sure that the specified value is unique in the region of the instance.
| newInstanceName |
CrossZone | boolean | No | Specifies whether cross-zone deployment is required. Valid values:
Default value: true. | false |
SecurityGroup | string | No | The security group of the instance. If you do not specify this parameter, ApsaraMQ for Kafka automatically configures a security group for your instance. If you specify this parameter, you must create a security group in advance. For more information, see Create a security group. | sg-bp13wfx7kz9pko**** |
ServiceVersion | string | No | The version of ApsaraMQ for Kafka. Valid values: 0.10.2 and 2.2.0. | 0.10.2 |
Config | string | No | The initial configurations of ApsaraMQ for Kafka. The value must be a valid JSON string. If you do not specify this parameter, it is left empty. The following parameters can be configured for Config:
| {"kafka.log.retention.hours":"33"} |
KMSKeyId | string | No | The ID of the key that is used for disk encryption in the region where the instance is deployed. You can obtain the ID of the key in the Key Management Service (KMS) console or create a key. For more information, see Manage CMKs. If this parameter is configured, disk encryption is enabled for the instance. You cannot disable disk encryption after disk encryption is enabled. When you call this operation, the system checks whether the AliyunServiceRoleForAlikafkaInstanceEncryption service-linked role is created. If the role is not created, the system automatically creates the role. For more information, see Service-linked roles. | 0d24xxxx-da7b-4786-b981-9a164dxxxxxx |
Notifier | string | No | The alert contact. | Mr. Wang |
UserPhoneNum | string | No | The mobile phone number of the alert contact. | 1581234**** |
SelectedZones | string | No | The two-dimensional arrays that consist of the candidate set for primary zones and the candidate set for secondary zones.
| [[\"zonel\"],[\"zonek\"]] |
IsForceSelectedZones | boolean | No | Specifies whether to forcibly deploy the instance in the selected zones. | false |
VSwitchIds | array | No | The vSwitch IDs. | |
string | No | The vSwitch ID. | vsw-gw8oeuz8kllbnb4m0qv5a |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": 200,
"Message": "operation success.",
"RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015****",
"Success": true
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2024-02-27 | The request parameters of the API has changed | see changesets | ||||
| ||||||
2023-10-09 | The request parameters of the API has changed | see changesets | ||||
|