查询数据处理服务 QPS 用量--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询数据处理服务 QPS 用量

最近更新时间：2024.08.09 10:27:35首次发布时间：2023.12.08 11:01:12

本接口支持通过自定义时间段，获取当前账号的数据处理服务 QPS 用量。

说明

该接口属于历史版本 API，建议您使用新版 DescribeImageXServerQPSUsage 接口。

注意事项

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

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=DescribeImageXServerQPSUsage&Version=2018-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXServerQPSUsage`	接口名称。当前 API 的名称为 `DescribeImageXServerQPSUsage`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceIds	String	否	`s1,s2`	服务 ID。为空时表示不筛选，支持查询多个服务，使用逗号分隔不同的服务。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考 GetAllImageServices。
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔不得超过 93 天。
EndTime	String	是	`2019-06-03T00:00:00+08:00`	获取数据结束时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔不得超过 93 天。
Interval	String	是	`300`	查询数据的时间粒度。单位为秒。支持以下取值： `1`: 单次查询最大时间跨度为 6 小时 `60`：单次查询最大时间跨度为 6 小时 `120`：单次查询最大时间跨度为 6 小时 `300`：单次查询最大时间跨度为 31 天 `600`：单次查询最大时间跨度为 31 天 `1200`：单次查询最大时间跨度为 31 天 `1800`：单次查询最大时间跨度为 31 天 `3600`：单次查询最大时间跨度为 93 天 `86400`：单次查询最大时间跨度为 93 天 `604800`：单次查询最大时间跨度为 93 天

返回参数

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

参数	类型	示例值	描述
QPSData	Array of QPSData	`-`	数据列表。

QPSData

参数类型示例值描述

参数	类型	示例值	描述
QPSType	String	`Request`	QPS 类型，取值如下所示： `Request`：专有图像处理和高效压缩 `Mirror`：资源下载与镜像代理
Data	Array of Data	`-`	时序数据。

QPSType

String

Request

QPS 类型，取值如下所示：

Request：专有图像处理和高效压缩
Mirror：资源下载与镜像代理

Data Array of Data - 时序数据。

Data

参数	类型	示例值	描述
TimeStamp	String	`2020-11-27T21:00:00+08:00`	统计时间点，时间片开始时刻，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。
Value	Integer	`12`	QPS 用量的值。单位为 "次/秒"，表示每秒处理的请求数量。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXServerQPSUsage&Version=2018-08-01&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-03T00:00:00+08:00&Interval=300

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXServerQPSUsage",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-beijing"
    },
    "Result": {
        "QPSData": [
            {
                "QPSType": "Request",
                "Data": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 12
                    }
                ]
            },
            {
                "QPSType": "Mirror",
                "Data": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 9
                    }
                ]
            }
        ]
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。