StartInstance
如需使用云消息队列 Kafka 版收发消息,需要购买并部署才可使用,本文介绍如何调用StartInstance部署实例
服务地址:
华东1 金融云
输入参数
只看必填
InstanceId实例的ID
RegionId实例的地域ID
VpcId实例部署的VPC ID
VSwitchId实例部署的vSwitch ID
DeployModule部署模式
ZoneId实例部署的可用区ID
IsEipInner是否支持EIP
请选择布尔值
IsSetUserAndPassword是否设置新的用户名和密码
请选择布尔值
Username用户名
Password用户密码
Name实例名称
CrossZone是否要跨可用区部署
请选择布尔值
SecurityGroup实例的安全组
ServiceVersion部署的云消息队列 Kafka 版的版本
Config部署的云消息队列 Kafka 版的初始配置
KMSKeyId同地域内的云盘加密的密钥ID
Notifier预警联系人
UserPhoneNum预警联系人手机号码
SelectedZones选择部署的主可用区候选集合
IsForceSelectedZones是否强制部署在所选可用区
请选择布尔值
VSwitchIds实例部署的vSwitch ID列表
0交换机ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

请求参数

字段名称字段详情
InstanceIdstring

实例的 ID。

示例值:alikafka_post-cn-v0h1fgs2****参考取值来源:
    GetAllInstanceIdList
    CreatePrePayInstance
RegionIdstring

实例的地域 ID。

示例值:cn-hangzhou
VpcIdstring

实例部署的 VPC ID。

示例值:vpc-bp1r4eg3yrxmygv****
VSwitchIdstring

实例部署的 vSwitch ID。

示例值:vsw-bp1j3sg5979fstnpl****
DeployModulestring

部署模式。预留实例中必填,Serverless 实例及 Confluent 系列实例非必填。取值:展开详情

示例值:vpc
ZoneIdstring

实例部署的可用区 ID。展开详情

示例值:cn-hangzhou-k
IsEipInnerboolean

是否支持 EIP 。取值:展开详情

示例值:false
IsSetUserAndPasswordboolean

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

示例值:false
Usernamestring

用户名。展开详情

示例值:username
Passwordstring

用户密码。展开详情

示例值:password
Namestring

实例名称。展开详情

示例值:newInstanceName
CrossZoneboolean

是否要跨可用区部署。展开详情

示例值:false
SecurityGroupstring

实例的安全组。展开详情

示例值:sg-bp13wfx7kz9pko****
ServiceVersionstring

部署的云消息队列 Kafka 版的版本。展开详情

示例值:预留实例系列:2.2.0 Serverless实例系列:3.3.1 Confluent系列:7.4.0
Configstring

部署的云消息队列 Kafka 版的初始配置。配置信息必须是一个合法的 JSON 字符串。不填写时,该参数默认为空。展开详情

示例值:{"kafka.log.retention.hours":"33"}
KMSKeyIdstring

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

示例值:0d24xxxx-da7b-4786-b981-9a164dxxxxxx
Notifierstring

预警联系人。

示例值:王先生
UserPhoneNumstring

预警联系人手机号码。

示例值:1581234****
SelectedZonesstring

选择部署的主可用区候选集合,以及备可用区候选集合的二维数组。支持自定义 code(zone{可用区})与标准 code(cn-RegionID-{可用区})。展开详情

示例值:[[\"zonel\"],[\"zonek\"]]
IsForceSelectedZonesboolean

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

示例值:false
VSwitchIdsarray<string>

实例部署的 vSwitch ID 列表,该参数在预留实例和 Serverless 实例中必填,Confluent 类型实例支持该参数,且 VSwitchIds 与 VSwitchId 需要至少填写一项,都填写时,优先使用 VSwitchIds。

子级条数 <= 100

返回参数

字段名称字段详情
Codeinteger<int32>

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

示例值:200
Messagestring

返回信息。

示例值:operation success.
RequestIdstring

请求 ID。

示例值:ABA4A7FD-E10F-45C7-9774-A5236015****
Successboolean

调用是否成功。

示例值:true
变更历史
暂无变更历史