StartInstance - 部署实例

调用StartInstance部署实例。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例的ID。

alikafka_post-cn-v0h1fgs2****
RegionIdstring

实例的地域ID。

cn-hangzhou
VpcIdstring

实例部署的VPC ID。

vpc-bp1r4eg3yrxmygv****
VSwitchIdstring

实例部署的vSwitch ID。

vsw-bp1j3sg5979fstnpl****
DeployModulestring

部署模式。取值:

  • vpc:VPC实例

  • eip:公网/VPC实例

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

vpc
ZoneIdstring

实例部署的可用区ID。

  • 必须为vSwitch的可用区ID。

  • 格式可以为zoneX,也可以为RegionId-X。例如,可以设置为zonea或者cn-hangzhou-k。

cn-hangzhou-k
IsEipInnerboolean

是否支持EIP 。取值:

  • true:公网/VPC实例

  • false:VPC实例

该参数取值必须与实例类型一致。例如,实例类型为VPC实例,则此处必须设置为false

false
IsSetUserAndPasswordboolean

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

  • true:设置新的用户名和密码。

  • false:不设置新的用户名和密码。

仅支持公网/VPC实例。

false
Usernamestring

用户名。

仅支持公网/VPC实例。

username
Passwordstring

用户密码。

仅支持公网/VPC实例。

password
Namestring

实例名称。

说明如果传递此参数,请确保此参数在同地域内唯一。
newInstanceName
SecurityGroupstring

实例的安全组。

不填写时,消息队列Kafka版会自动为您的实例配置安全组。如需填写,您需要先为实例创建安全组。具体操作,请参见创建安全组

sg-bp13wfx7kz9pko****
ServiceVersionstring

部署的消息队列Kafka版的版本,可选值为0.10.2或2.2.0。

0.10.2
Configstring

部署的消息队列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。修改该配置前,请确认修改值是否匹配生产和消费客户端相应配置。
{"kafka.log.retention.hours":"33"}
KMSKeyIdstring

同地域内的云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID,也可以创建新的密钥。具体操作,请参见管理密钥

传入此参数表示开启实例加密(开启后无法关闭),在调用该接口时,系统会检查是否创建服务关联角色AliyunServiceRoleForAlikafkaInstanceEncryption,若未创建,则会自动创建服务关联角色。更多信息,请参见服务关联角色

0d24xxxx-da7b-4786-b981-9a164dxxxxxx
Notifierstring

预警联系人

王先生
UserPhoneNumstring

预警联系人手机号码

1581234****
SelectedZonesstring

选择部署的可用区

[[\"zonel\"],[\"zonek\"]]
IsForceSelectedZonesboolean

是否强制部署在所选可用区

false

返回参数

名称类型描述示例值
object
Codeinteger

返回码。返回200代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求ID。

ABA4A7FD-E10F-45C7-9774-A5236015****
Successboolean

调用是否成功。

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 
&公共请求参数

正常返回示例

JSON格式

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

XML格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-22 OpenAPI StartInstance 已下线
变更项变更内容
阿里云首页 消息队列Kafka版 相关技术圈