DescribeCluster - AWS Snowball

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeCluster

傳回特定叢集的相關資訊,包括運送資訊、叢集狀態,以及其他重要的中繼資料。

請求語法

{ "ClusterId": "string" }

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

請求接受採用 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

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: