本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# DescribeCluster
<a name="API_DescribeCluster"></a>

**注意**  
 AWS Snowball Edge 不再向新客户提供。新客户应探索[AWS DataSync](https://aws.amazon.com/datasync/)在线传输、用于安全物理[传输AWS 的数据传输终端](https://aws.amazon.com/data-transfer-terminal/)或 AWS 合作伙伴解决方案。对于边缘计算，请浏览 [AWS Out](https://aws.amazon.com/outposts/) posts。

返回有关特定集群的信息，包括发运信息、集群状态和其他重要元数据。

## 请求语法
<a name="API_DescribeCluster_RequestSyntax"></a>

```
{
   "ClusterId": "string"
}
```

## 请求参数
<a name="API_DescribeCluster_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ClusterId](#API_DescribeCluster_RequestSyntax) **   <a name="Snowball-DescribeCluster-request-ClusterId"></a>
为集群自动生成的 ID。  
类型：字符串  
长度限制：固定长度为 39。  
模式：`CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必需：是

## 响应语法
<a name="API_DescribeCluster_ResponseSyntax"></a>

```
{
   "ClusterMetadata": { 
      "AddressId": "string",
      "ClusterId": "string",
      "ClusterState": "string",
      "CreationDate": number,
      "Description": "string",
      "ForwardingAddressId": "string",
      "JobType": "string",
      "KmsKeyARN": "string",
      "Notification": { 
         "DevicePickupSnsTopicARN": "string",
         "JobStatesToNotify": [ "string" ],
         "NotifyAll": boolean,
         "SnsTopicARN": "string"
      },
      "OnDeviceServiceConfiguration": { 
         "EKSOnDeviceService": { 
            "EKSAnywhereVersion": "string",
            "KubernetesVersion": "string"
         },
         "NFSOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         },
         "S3OnDeviceService": { 
            "FaultTolerance": number,
            "ServiceSize": number,
            "StorageLimit": number,
            "StorageUnit": "string"
         },
         "TGWOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         }
      },
      "Resources": { 
         "Ec2AmiResources": [ 
            { 
               "AmiId": "string",
               "SnowballAmiId": "string"
            }
         ],
         "LambdaResources": [ 
            { 
               "EventTriggers": [ 
                  { 
                     "EventResourceARN": "string"
                  }
               ],
               "LambdaArn": "string"
            }
         ],
         "S3Resources": [ 
            { 
               "BucketArn": "string",
               "KeyRange": { 
                  "BeginMarker": "string",
                  "EndMarker": "string"
               },
               "TargetOnDeviceServices": [ 
                  { 
                     "ServiceName": "string",
                     "TransferOption": "string"
                  }
               ]
            }
         ]
      },
      "RoleARN": "string",
      "ShippingOption": "string",
      "SnowballType": "string",
      "TaxDocuments": { 
         "IND": { 
            "GSTIN": "string"
         }
      }
   }
}
```

## 响应元素
<a name="API_DescribeCluster_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ClusterMetadata](#API_DescribeCluster_ResponseSyntax) **   <a name="Snowball-DescribeCluster-response-ClusterMetadata"></a>
有关特定集群的信息，包括配送信息、集群状态和其他重要元数据。  
类型：[ClusterMetadata](API_ClusterMetadata.md) 对象

## 错误
<a name="API_DescribeCluster_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** InvalidResourceException **   
找不到指定的资源。请查看您在上次请求中提供的信息，然后重试。    
 ** ResourceType **   
提供的资源值无效。
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeCluster_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/DescribeCluster) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/DescribeCluster) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/snowball-2016-06-30/DescribeCluster) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/DescribeCluster)