调用StartInstance部署实例。

说明 单用户请求频率限制为2 QPS。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String StartInstance

要执行的操作。取值:StartInstance

DeployModule String vpc

部署模式。取值:

  • vpc:VPC实例
  • eip:公网/VPC实例

实例的部署模式必须与其类型一致。VPC实例,部署模式为vpc。公网/VPC实例,部署模式为eip

InstanceId String alikafka_post-cn-v0h1fgs2****

实例的ID。

RegionId String cn-shanghai

实例的地域ID。

VpcId String vpc-bp1r4eg3yrxmygv****

实例部署的VPC ID

VSwitchId String vsw-bp1j3sg5979fstnpl****

实例部署的Vswitch ID。

ZoneId String cn-shanghai-a

实例部署的Zone ID。

  • 必须为Vswitch的Zone ID。
  • 格式可以为zoneX,也可以为RegionId-X。例如,可以设置为zonea或者cn-shanghai-a。
IsEipInner Boolean false

是否支持EIP 。取值:

  • true:公网/VPC实例
  • false:VPC实例

EIP支持必须与实例类型一致。

IsSetUserAndPassword Boolean false

是否设置新的用户名和密码。取值:

  • true:设置新的用户名和密码。
  • 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目前支持的参数配置如下:

  • enable.vpc_sasl_ssl:是否开启VPC传输加密。取值说明如下:
    • true:开启VPC传输加密。如果开启,则须同时开启ACL。
    • false:默认值,不开启VPC传输加密。
  • enable.acl:是否开启ACL。取值说明如下:
    • true:开启ACL。
    • false:默认值,不开启ACL。
  • kafka.log.retention.hours:在磁盘容量充足的情况下,消息的最长保留时间。单位:小时。取值范围[24, 480],默认值72。磁盘容量不足(即磁盘水位达到85%)时,将提前删除旧的消息,以确保服务可用性。
  • kafka.message.max.bytes:消息队列Kafka版能收发的消息的最大值,单位:字节。取值范围[1048576, 10485760],默认值1048576。修改该配置前,请确认修改值是否匹配生产和消费客户端相应配置。
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)://[Endpoint]/?Action=StartInstance
&DeployModule=vpc
&InstanceId=alikafka_post-cn-v0h1fgs2****
&RegionId=cn-shanghai
&VpcId=vpc-bp1r4eg3yrxmygv****
&VSwitchId=vsw-bp1j3sg5979fstnpl****
&ZoneId=cn-shanghai-a
&<公共请求参数>

正常返回示例

XML格式

<StartInstanceResponse>
      <Message>operation success.</Message>
      <RequestId>ABA4A7FD-E10F-45C7-9774-A5236015A***</RequestId>
      <Success>true</Success>
      <Code>200</Code>
</StartInstanceResponse>

JSON格式

{
    "RequestId":"ABA4A7FD-E10F-45C7-9774-A5236015A***",
    "Message":"operation success.",
    "Code":"200",
    "Success":"true"
}

错误码

访问错误中心查看更多错误码。