文档中心

获取资源用量概览

最近更新时间：2023.05.26 12:00:13

首次发布时间：2021.02.23 10:42:24

本接口通过指定服务数据范围以及服务 ID，来获取用户的本月资源用量概览，包括带宽、流量、存储、请求次数、基础图像处理。

请求说明

接口名称：DescribeImageXSummary
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageXSummary&Version=2018-08-01
请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：
- 查询当月流量用量时数据延迟为 30 分钟；
- 查询当月带宽用量时数据延迟为 30 分钟；
- 查询当月图像处理量时数据延迟为 30 分钟；
- 查询当月源站请求次数时数据延迟为 30 分钟；
- 查询当月最新一日资源占用量时数据延迟为 1 天。

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
Timestamp	String	是	数据查询时间段，即`Timestamp`所在月份的 1 日 0 时起至传入时间`Timestamp`的时间范围。格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
ServiceIds	String	否	服务 ID。为空时表示不筛选，支持查询多个服务，使用逗号分隔不同的服务。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

返回参数

参数	类型	描述
CdnTrafficData	Object of CdnTrafficData	当月流量用量
CdnBandwidthData	Object of CdnBandwidthData	当月带宽用量
StorageData	Object of StorageData	当月资源占用量
RequestCntData	Object of RequestCntData	当月源站请求次数
BaseOpData	Object of BaseOpData	当月图像处理量

CdnTrafficData

参数	类型	描述
Value	Integer	当月流量用量，单位为：Byte。

CdnBandwidthData

参数	类型	描述
Value	Float	当月带宽用量，单位为：bps。

StorageData

参数	类型	描述
Value	Float	当月最新一日资源占用量，单位为：Byte。

RequestCntData

参数	类型	描述
Value	Integer	当月源站请求次数，单位为：次。

BaseOpData

参数	类型	描述
Value	Integer	当月图像处理量，单位为：Byte。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXSummary&Version=2018-08-01&Timestamp=2022-08-03T00:00:00%2B08:00&ServiceIds=test

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220322174114010204055149180006F0",
        "Action": "DescribeImageXSummary",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "StorageData": {
            "Value": 0
        },
        "CdnBandwidthData": {
            "Value": 0
        },
        "CdnTrafficData": {
            "Value": 0
        },
        "RequestCntData": {
            "Value": 0
        },
        "BaseOpData": {
            "Value": 0
        }
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "DescribeImageResourceUsage",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": { 
        		"CodeN": 280400, 
            "Code": "", 
            "Message": "parse query error" 
            } 
        }, 
        "Result": null
}

错误码

访问错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：