DescribeCluster - Amazon Snowball
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

DescribeCluster

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

请求语法

{ "ClusterId": "string" }

请求参数

有关所有操作的通用参数的信息,请参阅通用参数

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

ClusterId

为集群自动生成的 ID。

类型:字符串

长度限制:固定长度为 39。

模式:CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

必需:是

响应语法

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

响应元素

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

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

ClusterMetadata

有关特定集群的信息,包括配送信息、集群状态和其他重要元数据。

类型:ClusterMetadata 对象

错误

有关所有操作返回的常见错误的信息,请参阅 常见错误

InvalidResourceException

找不到指定的资源。请查看您在上次请求中提供的信息,然后重试。

HTTP 状态代码:400

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: