云消息队列 Kafka 版：StartInstance - 部署实例

实例的 ID。

实例的地域 ID。

实例部署的 VPC ID。

实例部署的 vSwitch ID。

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

• vpc：VPC 实例

• eip：公网/VPC 实例

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

实例部署的可用区 ID。

• 必须为 vSwitch 的可用区 ID。

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

是否支持 EIP 。取值：

• true：公网/VPC 实例

• false：VPC 实例

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

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

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

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

仅支持公网/VPC 实例。

用户名。

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

• Confluent 只能填写 root 或者空。

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

用户密码。

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

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

实例名称。

是否要跨可用区部署。

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

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

默认值：true。

实例的安全组。

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

部署的云消息队列 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

部署的云消息队列 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。修改该配置前，请确认修改值是否匹配生产和消费客户端相应配置。

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

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

预警联系人。

预警联系人手机号码。

选择部署的主可用区候选集合，以及备可用区候选集合的二维数组。支持自定义 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 个数组，第二个表示备可用区候选集合的数组为空[]即可。

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

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