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
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
