Recuperar as métricas de um complemento

Artigo
08/24/2015

Aplica-se a: Windows Azure Pack

Recupera as métricas de complemento da data de início especificada para a data de término especificada.

Solicitação

Substitua <ServiceMgmt> pelo endereço do ponto de extremidade da API de Gerenciamento de Serviços. Substitua <AddonId> pelo identificador do complemento para as métricas que estão sendo coletadas.

Método	URI da solicitação	Versão HTTP
GET	<https:// ServiceMgmt>:30004/addons/<AddonId>/metrics	HTTP/1.1

Parâmetros de URI

A tabela a seguir descreve os parâmetros de URI.

Parâmetro do URI	Descrição
startTime	Obrigatórios. O DateTime para iniciar a coleta de métricas.
endTime	Obrigatórios. O DateTime para interromper a coleta de métricas.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.

Cabeçalho da solicitação	Descrição
Autorização: Portador	Obrigatórios. O token de portador de autorização.
x-ms-principal-id	Obrigatórios. O identificador principal.
x-ms-client-request-id	Opcional. O identificador de solicitação do cliente.
x-ms-client-session-id	Opcional. O identificador da sessão do cliente.
x-ms-principal-liveid	Opcional. O identificador live principal.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

Uma operação bem-sucedida retorna o código de status 200 (OK). Retorna 404 se os parâmetros de URI estiverem incorretos.

Para obter informações sobre códigos de status, consulte Status e Códigos de Erro (Windows Gerenciamento de Serviço do Azure Pack).

Cabeçalhos de resposta

A resposta para essa operação inclui cabeçalhos HTTP padrão. Todos os cabeçalhos padrão estão em conformidade com a especificação de protocolo HTTP/1.1.

Corpo da resposta

A tabela a seguir descreve os elementos do corpo da resposta.

Nome

O nome da métrica. Isso pode incluir "DailySignupCount" ou "TotalSignupCount".

PrimaryAggregationType

O tipo de agregação primária de métrica. Os valores incluem "Total"

ConfigState

A unidade de métrica. Os valores incluem "Bytes" BytesPerSec", "Count", "Megabytes", "Milliseconds", "Other", "Percentage", "Seconds".

TimeGrain

O intervalo de tempo da métrica.

StartTime

A hora de início do conjunto retornado de valores de métrica.

EndTime

A hora de término do conjunto retornado de valores de métrica.

Valores

Uma lista de valores de métrica. No caso do tipo de agregação "Contagem", o seguinte formato é usado:

Nome do elemento	Descrição
Tempo Criado	O DateTime em que o valor da métrica foi registrado.
Total	Para "DailySignUp" – O número total de inscrições diárias registradas. Para "TotalSignUp" O número total de inscrições.
Mínimo	O valor mínimo
Máximo	O valor máximo
Contagem	A contagem de valores

Exemplo

O exemplo de código a seguir mostra uma solicitação Adicionar Métricas de Complemento .

GET https://<Computer>:30004/addons/GoldAhihps8jy/metrics?startTime=2013-06-22T07%3a00%3a00.0000000Z&endTime=2013-06-29T07%3a00%3a00.0000000Z HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 5b933374-0387-4f5d-8bce-13f5c067d54b-2013-06-28 18:30:18Z
x-ms-client-session-id: d19ca528-d7bf-4a62-9d4d-03adbb4f6c74
x-ms-principal-id: <COMPUTER>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <COMPUTER>\Administrator
Host: <Computer>:30004

O exemplo de código a seguir mostra uma resposta adicionar métricas de complemento .

[
  {
    "Name": "DailySignupCount",
    "PrimaryAggregationType": "Total",
    "Unit": "Count",
    "TimeGrain": "1.00:00:00",
    "StartTime": "2013-06-22T07:00:00Z",
    "EndTime": "2013-06-29T07:00:00Z",
    "Values": [
      {
        "TimeCreated": "2013-06-22T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-23T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-28T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      }
    ]
  },
  {
    "Name": "TotalSignupCount",
    "PrimaryAggregationType": "Total",
    "Unit": "Count",
    "TimeGrain": "1.00:00:00",
    "StartTime": "2013-06-22T07:00:00Z",
    "EndTime": "2013-06-29T07:00:00Z",
    "Values": [
      {
        "TimeCreated": "2013-06-22T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-27T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-28T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      }
    ]
  }
]

Consulte Também

Interfaces de complemento do administrador

Compartilhar via