Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
DescribeCluster
nota
A partir del 7 de noviembre de 2025, solo AWS Snowball Edge estará disponible para los clientes actuales. Si quieres usarlo AWS Snowball Edge, regístrate antes de esa fecha. Los nuevos clientes deberían AWS DataSync
Devuelve información sobre un clúster específico que incluye información de envío, estado del clúster y otros metadatos importantes.
Sintaxis de la solicitud
{
"ClusterId": "string"
}Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- ClusterId
-
El ID generado automáticamente para un clúster.
Tipo: cadena
Limitaciones de longitud: longitud fija de 39.
Patrón:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Obligatorio: sí
Sintaxis de la respuesta
{
"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 respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- ClusterMetadata
-
Información sobre un clúster específico, que incluye información de envío, estado del clúster y otros metadatos importantes.
Tipo: objeto ClusterMetadata
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidResourceException
-
No se ha encontrado el recurso especificado. Compruebe la información que proporcionó en la última solicitud e inténtelo de nuevo.
- ResourceType
-
El valor de recurso proporcionado no es válido.
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
