Recuperar as métricas para um plano
Aplica-se a: Windows Azure Pack
Recupera as métricas do plano desde a data de início fornecida até à data de fim fornecida.
Pedir
Especifique o pedido de Métricas do Plano: Substitua <o ServiceMgmt> pelo seu endereço de ponto final da API de Gestão de Serviços. <PlanIdentifier> deve ser substituído pelo identificador de plano para o plano que está a ser recuperado.
Método |
URI do pedido |
Versão HTTP |
|---|---|---|
GET |
<https:// ServiceMgmt>:30004/planos/<PlanIdentifier> |
HTTP/1.1 |
Parâmetros do URI
Este pedido tem os seguintes parâmetros URI.
Parâmetro URI |
Description |
|---|---|
startTime |
Obrigatório. O DateTime para começar a recolha métrica a partir de. |
endTime |
Obrigatório. O DateTime para terminar a recolha métrica. |
Pedido cabeçalhos
A tabela seguinte descreve os cabeçalhos de pedido necessários e opcionais.
Cabeçalho do pedido |
Description |
|---|---|
Autorização: Portador |
Obrigatório. O sinal do portador da autorização. |
x-ms-principal-id |
Obrigatório. O identificador principal. |
x-ms-cliente-pedido-id |
Opcional. O identificador de pedido do cliente. |
x-ms-cliente-sessão-id |
Opcional. O identificador da sessão do cliente. |
x-ms-principal-liveid |
Opcional. O principal identificador ao vivo. |
Corpo do Pedido
Nenhum.
Resposta
A resposta inclui um código de estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.
Código de Estado
Uma operação bem sucedida devolve o código de estado 200 (OK). Se os parâmetros URI estiverem incorretos, este pedido devolve 404.
Para obter informações sobre códigos de estado, consulte Códigos de Estado e de Erro (Windows Gestão de Serviços de Pacote Azure).
Cabeçalhos de Resposta
A resposta contém cabeçalhos HTTP padrão. Todos os cabeçalhos standard estão de acordo com a especificação do protocolo HTTP/1.1.
Corpo de Resposta
A tabela seguinte descreve os elementos do corpo de pedido.
Nome do elemento |
Descrição |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nome |
O nome métrico. Os valores possíveis incluem DailySignupCount ou TotalSignupCount. |
||||||||||||
PrincipalAggregationType |
O tipo de agregação primária métrica. Os valores incluem total. |
||||||||||||
Unidade |
A unidade métrica. Os valores possíveis são:
|
||||||||||||
TimeGrain |
O grão de tempo métrico. |
||||||||||||
StartTime |
A hora de início para o conjunto devolvido de valores métricos. |
||||||||||||
EndTime |
O tempo final para o conjunto devolvido de valores métricos. |
||||||||||||
Valores |
Uma lista de valores métricos. No caso do tipo de agregação Count , é utilizado o seguinte formato:
|
Exemplo
O seguinte exemplo de código mostra um pedido de Get Plan Metrics .
GET https://<Computer>:30004/plans/Svclvfrkussi3occcwh/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: 3f9565a5-bdf6-41ac-a61e-d2de886f95df-2013-06-28 18:13:40Z
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 seguinte exemplo de código mostra uma resposta Get Plan Metrics .
[
{
"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
}
]
},
{
"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-28T07:00:00Z",
"Total": 0,
"Minimum": null,
"Maximum": null,
"Count": 1
}
]
}
]