DescribeStorageSystemResourceMetrics - AWS DataSync
Sintaxis de la solicitudParámetros de solicitudSintaxis de la respuestaElementos de respuestaErroresEjemplosVéase también

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.

DescribeStorageSystemResourceMetrics

Devuelve información, incluidos los datos de rendimiento y el uso de la capacidad, que DataSync Discovery recopila sobre un recurso específico en el sistema de almacenamiento local.

Sintaxis de la solicitud

{
   "DiscoveryJobArn": "string",
   "EndTime": number,
   "MaxResults": number,
   "NextToken": "string",
   "ResourceId": "string",
   "ResourceType": "string",
   "StartTime": number
}

Parámetros de 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.

DiscoveryJobArn

Especifica el nombre de recurso de Amazon (ARN) del trabajo de descubrimiento que recopila información sobre el sistema de almacenamiento local.

Tipo: String

Limitaciones de longitud: longitud máxima de 256.

Patrón: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Obligatorio: sí

EndTime

Especifica un tiempo dentro de la duración total durante la que se ejecutó el trabajo de detección. Para ver la información recopilada durante un período de tiempo determinado, utilice este parámetro conStartTime.

Tipo: Timestamp

Obligatorio: no

MaxResults

Especifica el número de resultados que desea incluir en la respuesta.

Tipo: entero

Rango válido: valor mínimo de 1. Valor máximo de 100.

Obligatorio: no

NextToken

Especifica una cadena opaca que indica la posición para comenzar la siguiente lista de resultados de la respuesta.

Tipo: String

Limitaciones de longitud máxima de.

Patrón: [a-zA-Z0-9=_-]+

Obligatorio: no

ResourceId

Especifica el identificador único universal (UUID) del recurso del sistema de almacenamiento sobre el que desea obtener información.

Tipo: String

Patrón: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Obligatorio: sí

ResourceType

Especifica el tipo de recurso del sistema de almacenamiento sobre el que desea obtener información.

Tipo: String

Valores válidos: SVM | VOLUME | CLUSTER

Obligatorio: sí

StartTime

Especifica un tiempo dentro de la duración total durante la que se ejecutó el trabajo de detección. Para ver la información recopilada durante un período de tiempo determinado, utilice este parámetro conEndTime.

Tipo: Timestamp

Obligatorio: no

Sintaxis de la respuesta

{
   "Metrics": [ 
      { 
         "Capacity": { 
            "LogicalUsed": number,
            "Provisioned": number,
            "Used": number
         },
         "P95Metrics": { 
            "IOPS": { 
               "Other": number,
               "Read": number,
               "Total": number,
               "Write": number
            },
            "Latency": { 
               "Other": number,
               "Read": number,
               "Write": number
            },
            "Throughput": { 
               "Other": number,
               "Read": number,
               "Total": number,
               "Write": number
            }
         },
         "ResourceId": "string",
         "ResourceType": "string",
         "Timestamp": number
      }
   ],
   "NextToken": "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.

Metrics

Los detalles que recopiló su trabajo de descubrimiento sobre el recurso del sistema de almacenamiento.

Tipo: Matriz de objetos ResourceMetrics

NextToken

La cadena opaca que indica la posición para comenzar la siguiente lista de resultados de la respuesta.

Tipo: String

Limitaciones de longitud máxima de.

Patrón: [a-zA-Z0-9=_-]+

Errores

Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.

InternalException

Esta excepción se produce cuando se produce un error en el AWS DataSync servicio.

Código de estado HTTP: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con formato incorrecto.

Código de estado HTTP: 400

Ejemplos

Solicitud de muestra

En el siguiente ejemplo, se solicita información sobre un volumen de un sistema de almacenamiento local.

{
    "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system-abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6",
    "ResourceType": "VOLUME",
    "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

Respuesta de ejemplo

El siguiente ejemplo de respuesta incluye información sobre el rendimiento y la capacidad del volumen.

{
    "Metrics": [
        {
            "Timestamp": "2023-01-10T13:54:11-05:00",
            "P95Metrics": {
                "IOPS": {
                    "Read": 251.0,
                    "Write": 44.0,
                    "Other": 17.0,
                    "Total": 345.0
                },
                "Throughput": {
                    "Read": 2.06,
                    "Write": 0.88,
                    "Other": 0.11,
                    "Total": 2.17
                },
                "Latency": {
                    "Read": 0.06,
                    "Write": 0.07,
                    "Other": 0.13
                }
            },
            "Capacity": {
                "Used": 409600,
                "Provisioned": 1099511627776
            },
            "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ResourceType": "VOLUME"
        }
    ]
}

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: