本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 的 Amazon MSK 範例 AWS CLI
下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon MSK 執行動作和實作常見案例。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。
**Topics**
+ [動作](#actions)
## 動作
### `create-cluster`
以下程式碼範例顯示如何使用 `create-cluster`。
**AWS CLI**
**建立 Amazon MSK 叢集**
下列 `create-cluster` 範例會建立名為 `MessagingCluster` 的 MSK 叢集，其中包含三個代理程式節點。名為 `brokernodegroupinfo.json` 的 JSON 檔案會指定您希望 Amazon MSK 分發代理程式節點的三個子網路。此範例不會指定監控層級，因此叢集會取得 `DEFAULT` 層級。
```
aws kafka create-cluster \
--cluster-name "MessagingCluster" \
--broker-node-group-info file://brokernodegroupinfo.json \
--kafka-version "2.2.1" \
--number-of-broker-nodes 3
```
`brokernodegroupinfo.json` 的內容：
```
{
"InstanceType": "kafka.m5.xlarge",
"BrokerAZDistribution": "DEFAULT",
"ClientSubnets": [
"subnet-0123456789111abcd",
"subnet-0123456789222abcd",
"subnet-0123456789333abcd"
]
}
```
輸出：
```
{
"ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
"ClusterName": "MessagingCluster",
"State": "CREATING"
}
```
如需有關詳細資訊，請參閱 *Amazon Managed Streaming for Apache Kafka* 中的[建立 Amazon MSK 叢集](https://docs.aws.amazon.com/msk/latest/developerguide/msk-create-cluster.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/create-cluster.html)。
### `create-configuration`
以下程式碼範例顯示如何使用 `create-configuration`。
**AWS CLI**
**建立自訂 Amazon MSK 組態**
下列 `create-configuration` 範例會使用輸入檔案中指定的伺服器屬性來建立自訂 MSK 組態。
```
aws kafka create-configuration \
--name "CustomConfiguration" \
--description "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms." \
--kafka-versions "2.2.1" \
--server-properties file://configuration.txt
```
`configuration.txt` 的內容：
```
auto.create.topics.enable = true
zookeeper.connection.timeout.ms = 2000
log.roll.ms = 604800000
```
此命令不會產生輸出。輸出：
```
{
"Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
"CreationTime": "2019-10-09T15:26:05.548Z",
"LatestRevision":
{
"CreationTime": "2019-10-09T15:26:05.548Z",
"Description": "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms.",
"Revision": 1
},
"Name": "CustomConfiguration"
}
```
如需詳細資訊，請參閱《Amazon Managed Streaming for Apache Kafka 開發人員指南》**中的 [Amazon MSK 組態操作](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-operations.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/create-configuration.html)。
### `describe-cluster`
以下程式碼範例顯示如何使用 `describe-cluster`。
**AWS CLI**
**描述叢集**
下列 `describe-cluster` 範例描述 Amazon MSK 叢集。
```
aws kafka describe-cluster \
--cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
```
輸出：
```
{
"ClusterInfo": {
"BrokerNodeGroupInfo": {
"BrokerAZDistribution": "DEFAULT",
"ClientSubnets": [
"subnet-cbfff283",
"subnet-6746046b"
],
"InstanceType": "kafka.m5.large",
"SecurityGroups": [
"sg-f839b688"
],
"StorageInfo": {
"EbsStorageInfo": {
"VolumeSize": 100
}
}
},
"ClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5",
"ClusterName": "demo-cluster-1",
"CreationTime": "2020-07-09T02:31:36.223000+00:00",
"CurrentBrokerSoftwareInfo": {
"KafkaVersion": "2.2.1"
},
"CurrentVersion": "K3AEGXETSR30VB",
"EncryptionInfo": {
"EncryptionAtRest": {
"DataVolumeKMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a7ca56d5-0768-4b64-a670-339a9fbef81c"
},
"EncryptionInTransit": {
"ClientBroker": "TLS_PLAINTEXT",
"InCluster": true
}
},
"EnhancedMonitoring": "DEFAULT",
"OpenMonitoring": {
"Prometheus": {
"JmxExporter": {
"EnabledInBroker": false
},
"NodeExporter": {
"EnabledInBroker": false
}
}
},
"NumberOfBrokerNodes": 2,
"State": "ACTIVE",
"Tags": {},
"ZookeeperConnectString": "z-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-3.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181"
}
}
```
如需詳細資訊，請參閱《Amazon Managed Streaming for Apache Kafka 開發人員指南》**中的[列示 Amazon MSK 叢集](https://docs.aws.amazon.com/msk/latest/developerguide/msk-list-clusters.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/describe-cluster.html)。
### `get-bootstrap-brokers`
以下程式碼範例顯示如何使用 `get-bootstrap-brokers`。
**AWS CLI**
**取得引導代理程式**
下列 `get-bootstrap-brokers` 範例會擷取 Amazon MSK 叢集的引導代理程式資訊。
```
aws kafka get-bootstrap-brokers \
--cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
```
輸出：
```
{
"BootstrapBrokerString": "b-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9092,b-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9092",
"BootstrapBrokerStringTls": "b-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9094,b-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9094"
}
```
如需詳細資訊，請參閱《Amazon Managed Streaming for Apache Kafka 開發人員指南》**中的[取得引導代理程式](https://docs.aws.amazon.com/msk/latest/developerguide/msk-get-bootstrap-brokers.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBootstrapBrokers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/get-bootstrap-brokers.html)。
### `list-clusters`
以下程式碼範例顯示如何使用 `list-clusters`。
**AWS CLI**
**列出可用的叢集**
下列`list-clusters`範例列出您 AWS 帳戶中的 Amazon MSK 叢集。
```
aws kafka list-clusters
```
輸出：
```
{
"ClusterInfoList": [
{
"BrokerNodeGroupInfo": {
"BrokerAZDistribution": "DEFAULT",
"ClientSubnets": [
"subnet-cbfff283",
"subnet-6746046b"
],
"InstanceType": "kafka.m5.large",
"SecurityGroups": [
"sg-f839b688"
],
"StorageInfo": {
"EbsStorageInfo": {
"VolumeSize": 100
}
}
},
"ClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5",
"ClusterName": "demo-cluster-1",
"CreationTime": "2020-07-09T02:31:36.223000+00:00",
"CurrentBrokerSoftwareInfo": {
"KafkaVersion": "2.2.1"
},
"CurrentVersion": "K3AEGXETSR30VB",
"EncryptionInfo": {
"EncryptionAtRest": {
"DataVolumeKMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a7ca56d5-0768-4b64-a670-339a9fbef81c"
},
"EncryptionInTransit": {
"ClientBroker": "TLS_PLAINTEXT",
"InCluster": true
}
},
"EnhancedMonitoring": "DEFAULT",
"OpenMonitoring": {
"Prometheus": {
"JmxExporter": {
"EnabledInBroker": false
},
"NodeExporter": {
"EnabledInBroker": false
}
}
},
"NumberOfBrokerNodes": 2,
"State": "ACTIVE",
"Tags": {},
"ZookeeperConnectString": "z-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181,z-3.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:2181"
}
]
}
```
如需詳細資訊，請參閱《Amazon Managed Streaming for Apache Kafka 開發人員指南》**中的[列示 Amazon MSK 叢集](https://docs.aws.amazon.com/msk/latest/developerguide/msk-list-clusters.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/list-clusters.html)。
### `update-broker-storage`
以下程式碼範例顯示如何使用 `update-broker-storage`。
**AWS CLI**
**更新代理程式的 EBS 儲存**
下列 `update-broker-storage` 範例會更新叢集中所有代理程式的 EBS 儲存量。Amazon MSK 會將每個代理程式的目標儲存量，設定為範例中指定的數量。您可以透過描述叢集，或列出所有叢集，來取得叢集的目前版本。
```
aws kafka update-broker-storage \
--cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \
--current-version "K21V3IB1VIZYYH" \
--target-broker-ebs-volume-info "KafkaBrokerNodeId=ALL,VolumeSizeGB=1100"
```
輸出會傳回此 `update-broker-storage` 操作的 ARN。要判斷此操作是否已完成，請搭配使用 `describe-cluster-operation` 命令和此 ARN 以做為輸入。
```
{
"ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
"ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE"
}
```
如需詳細資訊，請參閱《Amazon Managed Streaming for Apache Kafka 開發人員指南》**中的[更新代理程式的 EBS 儲存](https://docs.aws.amazon.com/msk/latest/developerguide/msk-update-storage.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateBrokerStorage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/update-broker-storage.html)。
### `update-cluster-configuration`
以下程式碼範例顯示如何使用 `update-cluster-configuration`。
**AWS CLI**
**更新 Amazon MSK 叢集的組態**
下列 `update-cluster-configuration` 範例會更新指定之現有 MSK 叢集的組態。範例會使用自訂 MSK 組態。
```
aws kafka update-cluster-configuration \
--cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \
--configuration-info file://configuration-info.json \
--current-version "K21V3IB1VIZYYH"
```
`configuration-info.json` 的內容：
```
{
"Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
"Revision": 1
}
```
輸出會傳回此 `update-cluster-configuration` 操作的 ARN。要判斷此操作是否已完成，請搭配使用 `describe-cluster-operation` 命令和此 ARN 以做為輸入。
```
{
"ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
"ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE"
}
```
如需詳細資訊，請參閱《Amazon Managed Streaming for Apache Kafka 開發人員指南》**中的[更新 Amazon MSK 叢集的組態](https://docs.aws.amazon.com/msk/latest/developerguide/msk-update-cluster-cofig.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateClusterConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/update-cluster-configuration.html)。