从 Apigee Analytics 服务检索和过滤维度的指标

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

API 平台基本路径：https://api.enterprise.apigee.com/v1/o/{org_name}

API 资源路径：/environments/{env_name}/stats/{dimension_name}

说明：使用 GET 方法检索维度的指标

动词： GET
身份验证： 基本身份验证
媒体类型：
应用/json
概览：通过 GET 请求（针对 /stats API 资源）生成报告，并附上以下信息：
  • 用于定义报告维度的可选 URI 参数。Apigee 会定义一组维度，并根据这些维度预汇总一组指标。如果没有定义维度（即 URI 参数为空），则系统会为指定环境中存在的所有 API 生成报告。
  • 一组查询参数，用于定义报告的指标、时间范围、时间间隔和过滤条件/展开细目。

dimension_name：一个 URI 参数，用于定义应检索 API 平台指标的实体。Apigee 定义了一组可用于报告的维度。支持的尺寸包括：

  • /stats/apis：API 平台上的组织中的 API 代理
  • /stats/apiproducts：在组织中定义的 API 产品
  • /stats/apps：向您的 API 发出请求的开发者应用的名称
  • /stats/client_ip：向 API 平台上的 API 发出请求的应用的 IP 地址
  • /stats/developer_email：在 API 平台上的组织中注册的开发者的电子邮件地址
  • /stats/developer_app：向您的 API 发出请求的开发者应用的名称
  • /stats/devs：在 API Platform 上的组织中注册的唯一开发者 ID，由 Edge 生成
  • /stats/access_token：应用最终用户的 OAuth 访问令牌
过滤

过滤器可应用于自定义资源。自定义资源包括：

符号 操作
in 用于列表包含
notin 针对列表排除
eq =
ne != 或
gt >
lt
ge >=
le
过滤条件示例
说明 过滤查询结构
名为 api1 或 api2 的 API 代理的统计信息 filter=(apiproxy in 'api1','api2')
除 api1 和 api2 以外的所有 API 代理的统计信息 filter=(apiproxy notin 'ap1','api2')
未出现错误的统计信息 filter=(iserror eq 0)
没有错误消息或 API 代理名称为 api1 或 api2 的统计信息 filter=(iserror eq 1) or (apiproxy in 'api1','api2')
统计数据，其中（响应代码为 201 或 301）和（存在错误）或（API 代理名称为 api1 或 api2） filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

示例请求：

$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
查询参数：
名称 说明 默认 是否必需？
select 指定要在报告中汇总的指标。支持的指标包括 message_count、error_count、total_response_time、max_response_time、min_response_time、data_Exchange_size、end_point_response_time 不适用 是
timeRange 所需间隔的开始时间和结束时间。日期格式为 MM/DD/YYYY HH:MM。例如 1/1/2013%2000:00~1/2/2013%2000:00。最长时间范围为 6 个月 不适用 是
timeUnit 秒、分钟、小时、天、周、月、季度、年、十年、世纪、千年 不适用 是
排序方式 如果指定了两个或多个选择值，“sortby”可用于指定用于对结果进行排序的选择：message_count、error_count、total_response_time、max_response_time、min_response_time、data_Exchange_size、end_point_response_time 不适用 否
sort 支持的排序范围为 DESC 或 ASC 不适用 否
托普克 例如，从结果中提取“前 k”个结果，以返回前 5 个结果“topk=5”。 不适用 否
filter 支持对特定的维度值展开深入分析 不适用 否
限制 设置 API 返回的条目数量限制 不适用 否
offset 使用具有限制的偏移，以启用结果分页。例如，如需显示 11-20 条结果，请将 limit 设置为“10”，将偏移量设置为“10”。 不适用 否
示例响应： 
{
  "environments" : [ {
        "dimensions" : [ {
          "metrics" : [ 
                 {
                "name" : "message_count",
                "values" : [ {
                   "timestamp" : 1335241800000,
                   "value" : "1.0"
                 } ]
              } ,
                 {
                 "name" : "error_count",
                 "values" : [ {
                    "timestamp" : 1335241800000,
                    "value" : "0.0"
                   } ]
            } 
              ],
        
               "name" : "api1"
        }, 
            {
          "metrics" : [ 
               {
              "name" : "message_count",
              "values" : [ {
                     "timestamp" : 1335241800000,
                     "value" : "1.0"
                  } ]
             },
                {
                "name" : "error_count",
                "values" : [ {
                      "timestamp" : 1335241800000,
                      "value" : "0.0"
                } ]
            } 
             ],
        
             "name" : "api2"
        } 
          ],
        
         "name" : "test"
      } 
    ],
   "metaData" : {
    }
}
响应载荷元素：
名称 说明
元数据 与报告关联的元数据
environments 组织中收集统计信息的环境（支持使用通配符 * 表示跨环境统计信息收集）
metrics 针对指定维度返回的值
dimensions 为衡量定义的维度：在此示例中为 api_name。
metrics 报告的指标