As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeCluster
nota
A partir de 7 de novembro de 2025, AWS Snowball Edge estará disponível somente para clientes existentes. Se você gostaria de usar AWS Snowball Edge, inscreva-se antes dessa data. Novos clientes devem explorar AWS DataSync
Retorna informações sobre um cluster específico, incluindo informações de remessa, o status do cluster e outros metadados importantes.
Sintaxe da Solicitação
{
"ClusterId": "string"
}Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.
A solicitação aceita os dados a seguir no formato JSON.
- ClusterId
-
O ID gerado automaticamente para um cluster.
Tipo: String
Restrições de tamanho: tamanho fixo de 39.
Padrão:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Exigido: Sim
Sintaxe da Resposta
{
"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"
}
}
}
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- ClusterMetadata
-
Retorna informações sobre um cluster específico, incluindo informações de envio, o status do cluster e outros metadados importantes.
Tipo: objeto ClusterMetadata
Erros
Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.
- InvalidResourceException
-
Não foi possível encontrar o recurso especificado. Confira as informações fornecidas na última solicitação e tente novamente.
- ResourceType
-
O valor do recurso fornecido é inválido.
Código de Status HTTP: 400
Consulte Também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
