检索计划的指标

项目
08/24/2015

适用于：Windows Azure Pack

从提供的开始日期检索计划指标到提供的结束日期。

请求

按如下所示指定“获取计划指标”请求：将 ServiceMgmt> 替换为<服务管理 API 终结点地址。 <PlanIdentifier> 应替换为要检索的计划的计划标识符。

方法	请求 URI	HTTP 版本
GET	<https:// ServiceMgmt>：30004/plans/<PlanIdentifier>	HTTP/1.1

URI 参数

此请求具有以下 URI 参数。

URI 参数	说明
startTime	必需。要从中开始收集指标的 DateTime。
endTime	必需。用于结束指标收集的 DateTime。

请求标头

下表介绍必需的和可选的请求标头。

请求标头	说明
授权：持有者	必需。授权持有者令牌。
x-ms-principal-id	必需。主体标识符。
x-ms-client-request-id	可选。客户端请求标识符。
x-ms-client-session-id	可选。客户端会话标识符。
x-ms-principal-liveid	可选。主体 Live 标识符。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

此操作成功后返回状态代码 200（正常）。如果 URI 参数不正确，则此请求返回 404。

有关状态代码的信息，请参阅“状态”和“错误代码” (Windows Azure Pack 服务管理) 。

响应标头

响应包含标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应正文

下表说明了请求正文的元素。

名称

指标名称。可能的值包括 DailySignupCount 或 TotalSignupCount。

PrimaryAggregationType

指标主要聚合类型。值包括 Total。

计价单位

指标单位。可能的值包括：

字节
BytesPerSec
计数
兆字节
毫秒
其他
百分比
秒

TimeGrain

指标时间粒度。

StartTime

返回的指标值集的开始时间。

EndTime

返回的指标值集的结束时间。

值

指标值的列表。对于 Count 聚合类型，使用以下格式：

元素名称	说明
创建时间	记录指标值的 DateTime。
总计	DailySignUp - 记录的每日注册总数。TotalSignUp - 注册总数。
最小值	最小值。
最大值	最大值。
计数	值计数。

示例

下面的代码示例演示 了“获取计划指标 ”请求。

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

下面的代码示例演示 了“获取计划指标” 响应。

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

另请参阅

管理员计划接口

通过