您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
API 平台基本路径：
https://api.enterprise.apigee.com/v1/o/{org_name}
API 资源路径： /environments/{env_name}/stats/{dimension_name}
说明：使用 GET 方法检索维度的指标
| 谓词： | 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：在 API 平台上的组织中注册的开发者的电子邮件地址/stats/developer_app：向您的 API 发出请求的开发者应用的名称/stats/devs：在 API 平台上的组织中注册的由 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
| 名称 | 说明 | 默认值 | 是否必需？ |
|---|---|---|---|
| 选择 | 指定要为报告汇总的指标。支持的指标包括 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 | 指定两个或更多选择值时，可以使用“sortby”指定用于对结果进行排序的选择：message_count、error_count、total_response_time、max_response_time、min_response_time、data_exchange_size、end_point_response_time | 不适用 | 否 |
| 排序 | 支持的排序范围为 DESC 或 ASC | 不适用 | 否 |
| topk | 从结果中获取“前 k”个结果，例如，返回前 5 个结果“topk=5”。 | 不适用 | 否 |
| 过滤条件 | 支持针对特定维度值进行下钻 | 不适用 | 否 |
| 限制 | 设置 API 返回的条目数量上限 | 不适用 | 否 |
| offset | 使用偏移量和限制来启用结果分页。例如，如需显示第 11-20 条结果，请将 limit 设置为“10”，并将 offset 设置为“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。 |
| 指标 | 报告的指标 |