ApsaraMQ for Kafka:StartInstance

インスタンス ID。

インスタンスが配置されるリージョン ID。

インスタンスがデプロイされる VPC の ID。

インスタンスがデプロイされる vSwitch の ID。

インスタンスのデプロイモード。プロビジョニング済みインスタンスの場合に必須です。サーバーレスおよび Confluent インスタンスの場合には必須ではありません。有効な値は以下のとおりです。

• vpc：VPC インスタンス

• eip：インターネット/VPC インスタンス

インスタンスのデプロイモードは、インスタントタイプと整合している必要があります。VPC インスタンスの場合は、このパラメーターを vpc に設定してください。インターネット/VPC インスタンスの場合は、このパラメーターを eip に設定してください。

インスタンスがデプロイされるゾーン ID。

• 値は、vSwitch のゾーン ID である必要があります。

• 値は zoneX または RegionId-X 形式で指定できます。たとえば、zonea や cn-hangzhou-k を指定できます。

EIP（Elastic IP Address）を有効化するかどうかを指定します。有効な値は以下のとおりです。

• true：インターネット/VPC インスタンス

• false：VPC インスタンス

このパラメーターの値は、インスタントタイプと整合している必要があります。たとえば、VPC インスタンスの場合は、このパラメーターを false に設定する必要があります。

新しいユーザー名およびパスワードを設定するかどうかを指定します。有効な値は以下のとおりです。

• true：新しいユーザー名およびパスワードを設定します。

• false：新しいユーザー名およびパスワードを設定しません。

このパラメーターは、インターネット/VPC インスタンスでのみサポートされます。

ユーザー名。

• プロビジョニング済みおよびサーバーレスインスタンスの場合、このパラメーターはインターネット/VPC インスタンスでのみサポートされます。

• Confluent インスタンスの場合、このパラメーターは root のみ、または空欄のままに設定できます。

デフォルト値：プロビジョニング済みおよびサーバーレスインスタンスでは username、Confluent インスタンスでは root です。

パスワード。

• プロビジョニング済みおよびサーバーレスインスタンスの場合、このパラメーターはインターネット/VPC インスタンスでのみサポートされます。

• Confluent インスタンスの場合、このパラメーターは必須です。パスワードの長さは 8～32 文字で、大文字、小文字、数字、特殊文字（!@#$%^&*()_+-=）のうち少なくとも 3 種類を含む必要があります。

インスタンスの名前。

このパラメーターは、サーバーレスおよび Confluent インスタンスではサポートされていません。

インスタンスをマルチゾーンでデプロイするかどうかを指定します。

• true：マルチゾーンでデプロイします。

• false：マルチゾーンでデプロイしません。

デフォルト値：true。

インスタンスのセキュリティグループ。

このパラメーターを指定しない場合、ApsaraMQ for Kafka が自動的にご利用のインスタンス用のセキュリティグループを設定します。このパラメーターを指定する場合は、事前にインスタンス用のセキュリティグループを作成しておく必要があります。「セキュリティグループの作成」をご参照ください。

デプロイする ApsaraMQ for Kafka インスタンスのバージョン。

• プロビジョニング済みインスタンスの場合、有効な値は 2.2.0 および 2.6.2 です。

• サーバーレスインスタンスの場合、有効な値は 3.3.1 です。

• Confluent インスタンスの場合、有効な値は 7.4.0 です。

デフォルト値：

• プロビジョニング済みインスタンス：2.2.0

• サーバーレスインスタンス：3.3.1

• Confluent インスタンス：7.4.0

ApsaraMQ for Kafka インスタンスの初期構成。値は有効な JSON 文字列である必要があります。このパラメーターを指定しない場合、デフォルト値は空文字列です。

リザーブドインスタンスでサポートされる Config パラメーターは以下のとおりです。

• enable.vpc_sasl_ssl

• enable.acl

• kafka.log.retention.hours

• kafka.message.max.bytes

サーバーレスインスタンスでサポートされる Config パラメーターは以下のとおりです。

• enable.vpc_sasl_ssl

• enable.acl

• log.retention.hours

• offsets.retention.minutes

• message.max.bytes

• auto.create.topics.enable

• num.partitions

詳細については、「UpdateInstanceConfig」をご参照ください。

同一リージョン内のディスク暗号化に使用されるキーの ID。キー ID は「Key Management Service (KMS) コンソール」で確認できます。また、新規にキーを作成することも可能です。「キーの管理」をご参照ください。

このパラメーターを指定すると、ディスク暗号化が有効化されます。一度有効化されたディスク暗号化は無効化できません。この操作を呼び出す際に、システムは AliyunServiceRoleForAlikafkaInstanceEncryption サービスリンクロールが作成されているかをチェックします。ロールが作成されていない場合、システムが自動的にロールを作成します。「サービスリンクロール」をご参照ください。

アラート連絡先。

アラート連絡先の携帯電話番号。

プライマリゾーン候補セットおよびセカンダリゾーン候補セットからなる 2 次元配列。値はカスタムコード（zone{zone}）または標準コード（cn-RegionID-{zone}）を使用できます。

• マルチゾーンでインスタンスをデプロイする場合（isCrossZone=true）、プライマリゾーン候補セットを Zone H または Zone F、セカンダリゾーン候補セットを Zone K に設定するには、このパラメーターを [[\"zoneh\",\"zonef\"],[\"zonek\"]] に設定します。この例ではカスタムコードを使用しています。

  説明

  プライマリゾーンまたはセカンダリゾーンに複数のゾーンを指定した場合、システムは優先順位なしでそのいずれかのゾーンを選択してデプロイします。たとえば、[[\"zoneh\",\"zonef\"],[\"zonek\"]] と設定した場合、デプロイされたインスタンスのプライマリゾーンは Zone H または Zone F、セカンダリゾーンは Zone K になります。

• マルチゾーンでインスタンスをデプロイしない場合（isCrossZone=false）かつ Zone K にインスタンスをデプロイする場合、このパラメーターを [[\"zonek\"],[]] に設定します。この例ではカスタムコードを使用しています。なお、2 つの配列を指定する必要があります。セカンダリゾーン候補セットを表す 2 つ目の配列は空の配列 [] でも構いません。

選択したゾーンに強制的にインスタンスをデプロイするかどうかを指定します。