调用StartInstance部署实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StartInstance |
系统规定参数。取值:StartInstance。 |
InstanceId | String | 是 | alikafka_post-cn-v0h1fgs2**** |
实例的ID。 |
RegionId | String | 是 | cn-hangzhou |
实例的地域ID。 |
VpcId | String | 是 | vpc-bp1r4eg3yrxmygv**** |
实例部署的VPC ID。 |
VSwitchId | String | 是 | vsw-bp1j3sg5979fstnpl**** |
实例部署的vSwitch ID。 |
DeployModule | String | 是 | vpc |
部署模式。取值:
实例的部署模式必须与其类型一致。VPC实例,部署模式为vpc。公网/VPC实例,部署模式为eip。 |
ZoneId | String | 否 | cn-hangzhou-k |
实例部署的可用区ID。
|
IsEipInner | Boolean | 否 | false |
是否支持EIP 。取值:
该参数取值必须与实例类型一致。例如,实例类型为VPC实例,则此处必须设置为false。 |
IsSetUserAndPassword | Boolean | 否 | false |
是否设置新的用户名和密码。取值:
仅支持公网/VPC实例。 |
Username | String | 否 | username |
用户名。 仅支持公网/VPC实例。 |
Password | String | 否 | password |
用户密码。 仅支持公网/VPC实例。 |
Name | String | 否 | newInstanceName |
实例名称。 说明 如果传递此参数,请确保此参数在同地域内唯一。
|
SecurityGroup | String | 否 | sg-bp13wfx7kz9pkow*** |
实例的安全组。 不填写时,消息队列Kafka版会自动为您的实例配置安全组。如需填写,您需要先为实例创建安全组。具体操作,请参见创建安全组。 |
ServiceVersion | String | 否 | 0.10.2 |
部署的消息队列Kafka版的版本,可选值为0.10.2或2.2.0。 |
Config | String | 否 | {"kafka.log.retention.hours":"33"} |
部署的消息队列Kafka版的初始配置。配置信息必须是一个合法的JSON字符串。 不填写时,该参数默认为空。 Config目前支持的参数配置如下:
|
KMSKeyId | String | 否 | 0d24xxxx-da7b-4786-b981-9a164dxxxxxx |
同地域内的云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID,也可以创建新的密钥。具体操作,请参见管理密钥。 传入此参数表示开启实例加密(开启后无法关闭),在调用该接口时,系统会检查是否创建服务关联角色AliyunServiceRoleForAlikafkaInstanceEncryption,若未创建,则会自动创建服务关联角色。更多信息,请参见服务关联角色。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 |
返回码。返回200代表成功。 |
Message | String | operation success. |
返回信息。 |
RequestId | String | ABA4A7FD-E10F-45C7-9774-A5236015A*** |
请求ID。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=StartInstance
&InstanceId=alikafka_post-cn-v0h1fgs2****
&RegionId=cn-hangzhou
&VpcId=vpc-bp1r4eg3yrxmygv****
&VSwitchId=vsw-bp1j3sg5979fstnpl****
&DeployModule=vpc
&ZoneId=cn-hangzhou-k
&IsEipInner=false
&IsSetUserAndPassword=false
&Username=username
&Password=password
&Name=newInstanceName
&SecurityGroup=sg-bp13wfx7kz9pkow***
&ServiceVersion= 0.10.2
&Config={"kafka.log.retention.hours":"33"}
&KMSKeyId=0d24xxxx-da7b-4786-b981-9a164dxxxxxx
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<StartInstanceResponse>
<Code>200</Code>
<Message>operation success.</Message>
<RequestId>ABA4A7FD-E10F-45C7-9774-A5236015A***</RequestId>
<Success>true</Success>
</StartInstanceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : 200,
"Message" : "operation success.",
"RequestId" : "ABA4A7FD-E10F-45C7-9774-A5236015A***",
"Success" : true
}
错误码
访问错误中心查看更多错误码。