查询高效压缩量--veImageX-火山引擎

文档中心

立即注册

导航

查询高效压缩量

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

本接口支持通过自定义查询时间段，查询该时间段的图像高效压缩量。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 20~30 分钟。
历史数据查询时间范围：近 1 年。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXCompressUsage`	接口名称。当前 API 的名称为 `DescribeImageXCompressUsage`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceIds	String	否	`s1,s2`	服务 ID。支持查询多个服务，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有服务。您可以在 veImageX 控制台的服务管理模块或者调用 GetAllImageServices 接口获取服务 ID。
GroupBy	String	否	`ServiceId`	需要分组查询的参数，当前仅支持取值 `ServiceId`，表示按服务 ID 进行分组。
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如`2019-06-02T00:00:00+08:00`。说明由于仅支持查询近一年历史数据，则若此刻时间为`2011-11-21T16:14:00+08:00`，那么您可输入最早的开始时间为`2010-11-21T00:00:00+08:00`。
EndTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据结束时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如`2019-06-02T00:00:00+08:00`。
Interval	String	否	`300`	查询数据的时间粒度。单位为秒。缺省时查询 `StartTime` 和 `EndTime` 时间段全部数据，此时单次查询最大时间跨度为 93 天。取值如下所示： `300`：单次查询最大时间跨度为 31 天 `600`：单次查询最大时间跨度为 31 天 `1200`：单次查询最大时间跨度为 31 天 `1800`：单次查询最大时间跨度为 31 天 `3600`：单次查询最大时间跨度为 93 天 `86400`：单次查询最大时间跨度为 93 天 `604800`：单次查询最大时间跨度为 93 天

返回参数

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

参数	类型	示例值	描述
CompressData	Array of CompressData	`-`	压缩量数据

CompressData

参数	类型	示例值	描述
ServiceId	String	`s1`	服务 ID。当 `GroupBy` 中包含 `ServiceId` 时，有返回值。
InSize	Array of InSize	`-`	压缩前大小，单位为 byte。
OutSize	Array of OutSize	`-`	压缩后大小，单位为 byte。

InSize

参数	类型	示例值	描述
TimeStamp	String	`2023-01-01T00:00:00+08:00`	数据对应时间点，时间片开始时刻。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Value	Float	`234`	压缩前大小或压缩后大小，单位为 byte。

OutSize

参数	类型	示例值	描述
TimeStamp	String	`2023-01-01T00:00:00+08:00`	数据对应时间点，时间片开始时刻。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Value	Float	`123`	压缩前大小或压缩后大小，单位为 byte。

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXCompressUsage&Version=2023-05-01&ServiceIds=s1,s2&GroupBy=ServiceId&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeImageXCompressUsage",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "CompressData": [
            {
                "InSize": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 234
                    }
                ],
                "OutSize": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 123
                    }
                ],
                "ServiceId": "s1"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 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 版本 DescribeImageXCompressUsage 接口文档现已停止维护，建议您参考本文档使用最新版本。