查询写入量数据，支持应用监控、可观测链路OpenTelemetry版、Prometheus、用户体验监控四大产品用量数据。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:QueryCommercialUsage | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IntervalInSec | integer | 是 | 数据片的时间间隔，单位为秒，最小值为 3600。 枚举值：
| 3600 |
| StartTime | long | 是 | 起始时间的时间戳，精确到毫秒。 | 1699200000000 |
| EndTime | long | 是 | 结束时间的时间戳，精确到毫秒。 | 1699286400000 |
| OrderBy | string | 否 | 排序依据，可设为任一 dimesion 枚举值：
| dataType |
| Metric | string | 是 | 指标名称，取值：USAGEFEE.STAT | USAGEFEE.STAT |
| Order | string | 否 | 排序标准。取值：
| ASC |
| AdvancedFilters | array<object> | 否 | 过滤条件数组 | |
| object | 否 | |||
| Key | string | 否 | 过滤条件的 key | regionId |
| Value | string | 否 | 过滤条件的 value | cn-hangzhou |
| OpType | string | 否 | 操作符，目前仅支持等于或者 in 枚举值：
| eq |
| Dimensions | array | 否 | 指标对应的维度。
| |
| string | 否 | 指标对应的维度。 | dataType | |
| Measures | array | 否 | 指标对应的测量数据。 | |
| string | 否 | 指标对应的测量数据。目前仅支持 byte_sum | byte_sum | |
| QueryType | string | 是 | 查询的数据返回类型：
| instantQuery |
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"HttpStatusCode": 0,
"Message": "success",
"RequestId": "99A663CB-8D7B-4B0D-A006-03C8EE38E7BB",
"Success": true,
"Data": {
"Complete": true,
"Items": [
{
"date": "1697108400",
"dataType": "metrics",
"byte_sum": 9497922
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ParameterMetricIllegal | The specified metric is invalid. | 参数metric非法 |
| 400 | ParameterMeasuresIllegal | The specified Measures is invalid. | Measures非法 |
| 400 | ParameterTimeStampIllegal | The specified timeStamp is invalid. | 时间参数非法 |
| 400 | ParameterOrderIllegal | The specified order is invalid. | 参数order非法 |
| 400 | ParameterPageSizeIllegal | The specified PageSize is invalid. | PageSize非法 |
| 400 | ParameterIntervalIllegal | The specified interval is invalid. | 参数Interval非法 |
| 400 | ParameterMeasuresMissing | You must specify measures. | 参数measures缺失 |
| 400 | ParameterDimensionsIllegal | The specified dimensions is invalid. | Dimensions非法 |
| 400 | ParameterRegionIdIllegal | The specified RegionId is invalid. | RegionId非法 |
| 400 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | 内部错误，建议重试。如果多次重试报错请联系钉钉服务账号。 |
| 403 | APINotAuthorize | The current user is not authorized to access the interface. | 当前用户无权限访问该接口 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
- 调用时为什么会出现 RAM 的权限问题？ 这可能是由于该 RAM 角色没有权限，您可以为用户添加权限，请参见借助 RAM 角色实现跨云账号访问资源。
- 怎么拉取列表数据（不考虑时间粒度）？ 将 queryType 设置为 instantQuery
- 返回时间非法，目前 intervalInSec 仅支持 3600 以及 8600,不支持其他间隔