如需使用云消息队列 Kafka 版收发消息,需要购买并部署才可使用,本文介绍如何调用StartInstance部署实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alikafka:StartInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例的 ID。 | alikafka_post-cn-v0h1fgs2**** |
RegionId | string | 是 | 实例的地域 ID。 | cn-hangzhou |
VpcId | string | 是 | 实例部署的 VPC ID。 | vpc-bp1r4eg3yrxmygv**** |
VSwitchId | string | 是 | 实例部署的 vSwitch ID。 | vsw-bp1j3sg5979fstnpl**** |
DeployModule | string | 是 | 部署模式。V2 系列实例中必填,V3 及 Confluent 系列实例非必填。取值:
实例的部署模式必须与其类型一致。VPC 实例,部署模式为 vpc。公网/VPC 实例,部署模式为 eip。 | vpc |
ZoneId | string | 否 | 实例部署的可用区 ID。
说明
当所填可用区资源不足时,可能部署的是其他可用区。
| cn-hangzhou-k |
IsEipInner | boolean | 否 | 是否支持 EIP 。取值:
该参数取值必须与实例类型一致。例如,实例类型为 VPC 实例,则此处必须设置为 false。 | false |
IsSetUserAndPassword | boolean | 否 | 是否设置新的用户名和密码。取值:
仅支持公网/VPC 实例。 | false |
Username | string | 否 | 用户名。
默认值:V2、V3 系列实例:username;Confluent 实例:root。 | username |
Password | string | 否 | 用户密码。
| password |
Name | string | 否 | 实例名称。 说明
如果传递此参数,请确保此参数在同地域内唯一。
| newInstanceName |
CrossZone | boolean | 否 | 是否要跨可用区部署。
默认值:true。 | false |
SecurityGroup | string | 否 | 实例的安全组。 不填写时,云消息队列 Kafka 版会自动为您的实例配置安全组。如需填写,您需要先为实例创建安全组。具体操作,请参见创建安全组。 | sg-bp13wfx7kz9pko**** |
ServiceVersion | string | 否 | 部署的云消息队列 Kafka 版的版本。
默认值:
| V2系列:2.2.0 V3系列:3.3.1 Confluent系列:7.4.0 |
Config | string | 否 | 部署的云消息队列 Kafka 版的初始配置。配置信息必须是一个合法的 JSON 字符串。不填写时,该参数默认为空。 说明
Confluent 实例暂不支持在部署时指定 Config。
Config 目前支持的参数配置如下:
| {"kafka.log.retention.hours":"33"} |
KMSKeyId | string | 否 | 0d24xxxx-da7b-4786-b981-9a164dxxxxxx | |
Notifier | string | 否 | 预警联系人。 | 王先生 |
UserPhoneNum | string | 否 | 预警联系人手机号码。 | 1581234**** |
SelectedZones | string | 否 | 选择部署的主可用区候选集合,以及备可用区候选集合的二维数组。支持自定义 code(
| [[\"zonel\"],[\"zonek\"]] |
IsForceSelectedZones | boolean | 否 | 是否强制部署在所选可用区。 | false |
VSwitchIds | array | 否 | 实例部署的 vSwitch ID 列表,该参数在 V2 和 V3 系列实例中必填,Confluent 类型实例支持该参数,且 VSwitchIds 与 VSwitchId 需要至少填写一项,都填写时,优先使用 VSwitchIds。 | |
string | 否 | 交换机 ID。 | ["vsw-bp1j3sg5979fstnpl****", "vsw-2ze8rwvzn7yi3r88****"] |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "operation success.",
"RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015****",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2024-02-27 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
2023-10-09 | OpenAPI 入参发生变更 | 看变更集 | ||||
|