DescribeStorageSystemResourceMetrics - AWS DataSync
Sintaxe da solicitaçãoParâmetros de solicitaçãoSintaxe da respostaElementos de respostaErrosExemplosConsulte também

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á.

DescribeStorageSystemResourceMetrics

Retorna informações, incluindo dados de desempenho e uso da capacidade, que o DataSync Discovery coleta sobre um recurso específico em seu sistema de armazenamento local.

Sintaxe da solicitação

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

Parâmetros de solicitação

Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

DiscoveryJobArn

Especifica o nome do recurso da Amazon (ARN) do trabalho de descoberta que coleta informações sobre o sistema de armazenamento no local.

Tipo: String

Restrições de tamanhos: tamanho máximo de 256.

Padrão: ^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}$

Obrigatório: Sim

EndTime

Especifica um tempo dentro da duração total em que a tarefa de descoberta foi executada. Para ver as informações coletadas durante um determinado período de tempo, use esse parâmetro comStartTime.

Tipo: Timestamp

Obrigatório: não

MaxResults

Especifica quantos resultados você deseja na resposta.

Tipo: inteiro

Faixa válida: valor mínimo de 1. Valor máximo de 100.

Obrigatório: não

NextToken

Especifica uma sequência de caracteres opaca que indica a posição para iniciar a próxima lista de resultados na resposta.

Tipo: String

Restrições de tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho

Padrão: [a-zA-Z0-9=_-]+

Obrigatório: não

ResourceId

Especifica o identificador universal exclusivo (UUID) do recurso do sistema de armazenamento sobre o qual você deseja informações.

Tipo: string

Padrão: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Obrigatório: Sim

ResourceType

Especifica o tipo de recurso do sistema de armazenamento sobre o qual você deseja obter informações.

Tipo: String

Valores válidos: SVM | VOLUME | CLUSTER

Obrigatório: Sim

StartTime

Especifica um tempo dentro da duração total em que a tarefa de descoberta foi executada. Para ver as informações coletadas durante um determinado período de tempo, use esse parâmetro comEndTime.

Tipo: Timestamp

Obrigatório: não

Sintaxe da resposta

{
   "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 resposta

Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

Metrics

Os detalhes que seu trabalho de descoberta coletou sobre o recurso do sistema de armazenamento.

Tipo: matriz de objetos ResourceMetrics

NextToken

A sequência opaca que indica a posição para iniciar a próxima lista de resultados na resposta.

Tipo: String

Restrições de tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho tamanho

Padrão: [a-zA-Z0-9=_-]+

Erros

Para obter informações sobre os erros comuns a todas as ações, consulteErros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro no AWS DataSync serviço.

Código de status HTTP: 500

InvalidRequestException

Essa exceção é lançada quando o cliente envia uma solicitação malformada.

Código de status HTTP: 400

Exemplos

Exemplo de solicitação

O exemplo a seguir solicita informações sobre um volume em um sistema de armazenamento 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"
}

Exemplo de resposta

O exemplo de resposta a seguir inclui informações de desempenho e capacidade sobre o volume.

{
    "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"
        }
    ]
}

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: