查询用量概览--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询用量概览

最近更新时间：2024.08.14 11:01:02首次发布时间：2024.04.12 15:11:26

本接口支持通过指定时间点以及服务 ID，查询本月用量概览，包括带宽、流量、存储、请求次数、基础图像处理。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：
- 查询当月流量用量时数据延迟为 30 分钟；
- 查询当月带宽用量时数据延迟为 30 分钟；
- 查询当月图像处理量时数据延迟为 30 分钟；
- 查询当月源站请求次数时数据延迟为 30 分钟；
- 查询当月最新一日资源占用量时数据延迟为 1 天。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=DescribeImageXSummary&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXSummary`	接口名称。当前 API 的名称为 `DescribeImageXSummary`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceIds	String	否	`s1,s2`	服务 ID。支持查询多个服务，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有服务。您可以在 veImageX 控制台的服务管理模块或者调用 GetAllImageServices 接口获取服务 ID。
Timestamp	String	是	`2019-06-02T00:00:00+08:00`	数据查询时间段，即`Timestamp`所在月份的 1 日 0 时起至传入时间`Timestamp`的时间范围。格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

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

CdnTrafficData

参数	类型	示例值	描述
Value	Long	`0`	当月流量用量，单位为：Byte。

CdnBandwidthData

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

StorageData

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

RequestCntData

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

BaseOpData

参数	类型	示例值	描述
Value	Long	`0`	当月图像处理量，单位为：Byte。

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXSummary&Version=2023-05-01&Timestamp=2019-06-02T00:00:00+08:00&ServiceIds=s1,s2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXSummary",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "CdnTrafficData": {
            "Value": 0
        },
        "CdnBandwidthData": {
            "Value": 0
        },
        "StorageData": {
            "Value": 0
        },
        "RequestCntData": {
            "Value": 0
        },
        "BaseOpData": {
            "Value": 0
        }
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter	Missing Parameter.	请求参数错误，请检查您的请求参数是否正确。
401	ParamAccountMismatch	Param {} did not belong to your account.	请求参数不属于账号，请检查您的请求参数是否正确。
500	InternalError	Internal Error.	内部错误，请提交工单联系技术支持。

服务端 SDK

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

历史版本

2018-08-01 版本 DescribeImageXSummary 接口文档现已停止维护，建议您参考本文档使用最新版本。