AI 助理
备案控制台
文档
输入文档关键字查找
首页 云消息队列 Kafka 版 云消息队列 Confluent 版 开发参考 API目录 实例 StartInstance - 部署实例

StartInstance - 部署实例

更新时间：
产品详情
我的收藏

如需使用云消息队列 Kafka 版收发消息，需要购买并部署才可使用，本文介绍如何调用StartInstance部署实例。

接口说明

说明

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用背景高亮的方式表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alikafka:StartInstance

update

全部资源

*

  • alikafka:DeployModule

  • alikafka:SpecType

  • alikafka:Acl

  • alikafka:DiskEncryption

无

请求参数

名称

类型

必填

描述

示例值

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

是

部署模式。预留实例中必填，Serverless 实例及 Confluent 系列实例非必填。取值：

  • vpc：VPC 实例

  • eip：公网/VPC 实例

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

vpc

ZoneId

string

否

实例部署的可用区 ID。

  • 必须为 vSwitch 的可用区 ID。

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

说明

当所填可用区资源不足时，可能部署的是其他可用区。

cn-hangzhou-k

IsEipInner

boolean

否

是否支持 EIP 。取值：

  • true：公网/VPC 实例

  • false：VPC 实例

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

false

IsSetUserAndPassword

boolean

否

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

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

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

仅支持公网/VPC 实例。

false

Username

string

否

用户名。

  • 预留实例、Serverless 实例仅支持公网/VPC 实例。

  • Confluent 只能填写 root 或者空。

默认值：预留实例、Serverless 实例：username；Confluent 实例：root。

username

Password

string

否

用户密码。

  • 预留实例、Serverless 实例仅支持公网/VPC 实例。

  • Confluent 实例中该参数必填，且需要满足在密码中，大写字母、小写字母、数字、特殊字符至少占三种，长度为 8-32 位，特殊字符为!@#$%^&*()_+-=。

password

Name

string

否

实例名称。

说明

如果传递此参数，请确保此参数在同地域内唯一。

newInstanceName

CrossZone

boolean

否

是否要跨可用区部署。

  • true：需要跨可用区部署。

  • false：不需要跨可用区部署。

默认值：true。

false

SecurityGroup

string

否

实例的安全组。

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

sg-bp13wfx7kz9pko****

ServiceVersion

string

否

部署的云消息队列 Kafka 版的版本。

  • 预留实例可选值为 2.2.0 或者 2.6.2。

  • Serverless 实例可选值为 3.3.1。

  • Confluent 系列可选值为 7.4.0。

默认值：

  • 预留实例系列：2.2.0

  • Serverless 实例系列：3.3.1

  • Confluent 系列：7.4.0

预留实例系列：2.2.0 Serverless实例系列：3.3.1 Confluent系列：7.4.0

Config

string

否

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

说明

  • Confluent 实例暂不支持在部署时指定 Config。

  • enable.acl 配置不支持 2.2.0 以下的实例版本，仅专业版、Serverless 版实例支持开启 ACL。

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"}

KMSKeyId

string

否

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

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

说明

Serverless 系列实例暂不支持在部署时指定 KMSKeyID。

0d24xxxx-da7b-4786-b981-9a164dxxxxxx

Notifier

string

否

预警联系人。

王先生

UserPhoneNum

string

否

预警联系人手机号码。

1581234****

SelectedZones

string

否

选择部署的主可用区候选集合，以及备可用区候选集合的二维数组。支持自定义 code（zone{可用区}）与标准 code（cn-RegionID-{可用区}）。

  • 当希望跨可用区部署（isCrossZone=true），并且主可用区候选集合为可用区 H 或可用区 F，备可用区候选集合为可用区 K，以自定义 code 为例，则传入参数为[[\"zoneh\",\"zonef\"],[\"zonek\"]]。

    说明

    当主或备可用区填写多个可用区时，表示从多个可用区中任选一个，且没有优先级关系，以[[\"zoneh\",\"zonef\"],[\"zonek\"]]为例，最终部署的主可用区为可用区 H 或可用区 F，备可用区为 K。

  • 当不希望跨可用区部署时（isCrossZone=false），可用区部署在可用区 K，以自定义 code 为例，则传入参数[[\"zonek\"],[]]，注意此时仍需传入 2 个数组，第二个表示备可用区候选集合的数组为空[]即可。

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

IsForceSelectedZones

boolean

否

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

false

VSwitchIds

array

否

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

string

否

交换机 ID。

["vsw-bp1j3sg5979fstnpl****", "vsw-2ze8rwvzn7yi3r88****"]

返回参数

名称

类型

描述

示例值

object

Code

integer

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

200

Message

string

返回信息。

operation success.

RequestId

string

请求 ID。

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

Success

boolean

调用是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

错误码请参见公共错误码。

变更历史

变更时间

变更内容概要

操作

2024-08-15

OpenAPI 描述信息更新

查看变更详情

2024-02-27

OpenAPI 入参发生变更

查看变更详情

2023-10-09

OpenAPI 入参发生变更

查看变更详情

上一篇：CreatePrePayOrder - 创建预付费实例下一篇：ModifyInstanceName - 修改实例的名称
文档推荐