<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
API 平台基本路径：
https://api.enterprise.apigee.com/v1/o/{org_name}
API 资源路径：/environments/{env_name}/stats/{dimension_name}
说明：使用 GET 方法检索维度的指标
| 动词： | 获取 |
| 身份验证： | 基本身份验证 |
| 媒体类型： |
application/json
|
概览：报告是使用
/stats API 中的 GET 请求生成的
资源，同时附上：
- 用于定义报告维度的可选 URI 参数。Apigee 定义了一组 即针对这些维度预先汇总一组指标。如果没有任何维度 （即，如果 URI 参数为空），则系统会针对所有 API 生成报告 指定环境中存在的所有资源。
- 一组查询参数，用于定义指标、时间范围、时间间隔和 过滤/展开报告的各个方面。
dimension_name：用于定义 API 所针对的实体的 URI 参数
应检索平台指标。Apigee 定义了一组维度，
报告。支持的尺寸包括：
/stats/apis：API 平台上组织中的 API 代理/stats/apiproducts：组织中定义的 API 产品/stats/apps：向您的 API 发出请求的开发者应用的名称/stats/client_ip：向 API 中的 API 发出请求的应用的 IP 地址 平台/stats/developer_email：在 管理组织/stats/developer_app：向以下对象发出请求的开发者应用的名称： 您的 API/stats/devs：由 Edge 生成的唯一开发者 ID，在 管理组织/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/2000:00~1/2/2013%2000:00。时间范围上限为 6 个月 | 不适用 | 是 |
| timeUnit | 秒、分钟、小时、日、周、月、季度、年、十年、世纪、千年 | 不适用 | 是 |
| sortby | 如果指定了两个或更多个 select 值，则设为 'sortby'可用于指定 select 用于对结果进行排序：message_count、error_count、total_response_time、 max_response_time、min_response_time、data_exchange_size、end_point_response_time | 不适用 | 否 |
| 排序 | 支持的排序范围为 DESC 或 ASC | 不适用 | 否 |
| topk | 搜索“top k”从搜索结果中返回前 5 条结果 “topk=5”。 | 不适用 | 否 |
| filter | 支持展开特定维度值细目 | 不适用 | 否 |
| 限制 | 设置 API 返回的条目数量限制 | 不适用 | 否 |
| offset | 使用 offset with limit 可启用结果分页。例如，要显示结果 11-20，将上限设置为“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 | 收集统计信息的组织中的环境（支持通配符） * 表示跨环境统计信息收集） |
| 指标 | 针对指定维度返回的值 |
| 尺寸 | 为测量定义的维度：在此示例中为 api_name。 |
| 指标 | 报告的指标 |