查询边缘请求次数--veImageX-火山引擎

文档中心

立即注册

导航

查询边缘请求次数

最近更新时间：2024.08.09 10:27:34首次发布时间：2022.12.29 16:35:42

本接口支持通过自定义查询时间段，查询该时间段的边缘请求次数。

说明

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

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 5~10 分钟。
历史数据查询时间范围：近 93 天。

请求说明

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

说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXEdgeRequest`	接口名称。当前 API 的名称为 `DescribeImageXEdgeRequest`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceIds	String	否	`s1,s2`	服务 ID。为空时表示不筛选，支持查询多个服务，使用逗号分隔不同的服务。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考 GetAllImageServices。
DomainNames	String	否	`d1,d2`	域名。为空时表示不筛选，支持查询多个域名，不同的域名使用逗号分隔。您可以通过调用 GetServiceDomains 获取服务下所有域名信息。
Regions	String	否	`中国大陆,北美区`	区域。传入多个时用英文逗号作为分割符，缺省情况下表示查询所有区域。取值如下所示： `中国大陆` `亚太一区` `亚太二区` `亚太三区` `欧洲区` `北美区` `南美区` `中东区`
UserCountry	String	否	`中国`	客户端国家。传入多个时用英文逗号作为分割符，缺省情况下表示不过滤。可调用获取边缘分发地区列表获取 IP 解析后的客户端国家。取值如下所示： `海外`，除中国外全部国家。具体国家取值，如`中国`、`美国`。
UserProvince	String	否	`北京`	客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用获取边缘分发地区列表获取 IP 解析后的客户端省份。
Protocols	String	否	`HTTP,HTTPS`	过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示： `HTTP` `HTTPS`
Isp	String	否	`移动,联通`	过滤运营商。传入多个用英文逗号分割，缺省情况下表示不过滤。取值如下所示： `电信` `联通` `移动` `鹏博士` `教育网` `广电网` `其它`
DataTypes	String	是	`req_cnt,2xx,3xx`	状态码。传入多个时用英文逗号分隔。支持以下取值： `req_cnt`：返回所有状态码数据 `2xx`：返回 2xx 状态码汇总数据 `3xx`：返回 3xx 状态码汇总数据 `4xx`：返回 4xx 状态码汇总数据 `5xx`：返回 5xx 状态码汇总数据。
GroupBy	String	否	`DomainName,DataType`	需要分组查询的参数。传入多个用英文逗号分割。支持以下取值： `DomainName`：域名 `DataType`：状态码
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 天的历史数据，则若此刻时间为`2011-11-21T16:14:00+08:00`，那么您可输入最早的开始时间为`2011-08-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 天。支持以下取值： `60`：单次查询最大时间跨度为 6 小时 `120`：单次查询最大时间跨度为 6 小时 `300`：单次查询最大时间跨度为 31 天 `600`：单次查询最大时间跨度为 31 天 `1200`：单次查询最大时间跨度为 31 天 `1800`：单次查询最大时间跨度为 31 天 `3600`：单次查询最大时间跨度为 93 天 `86400`：单次查询最大时间跨度为 93 天 `604800`：单次查询最大时间跨度为 93 天
DetailedCode	Boolean	否	`true`	是否拆分状态码。取值如下所示： `true`：拆分 `false`：（默认）不拆分

返回参数

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

参数	类型	示例值	描述
RequestCnt	Array of RequestCnt		数据列表说明若未设置`Interval`，则上报一条`StartTime`与`EndTime`时间段内查询的全部请求次数据。若设置了`Interval`，则按`Interval`粒度分段上报查询的时间粒度内请求次数据。

RequestCnt

参数	类型	示例值	描述
Data	Array of Data		具体数据
DataType	String	`500`	数据类型，当`GroupBy`指定了`DataType`时有返回值。
DomainName	String	`d1`	域名，`GroupBy`指定了`DomainName`时有返回值。

Data

参数	类型	示例值	描述
TimeStamp	String	`2022-10-19T00:00:00+08:00`	统计时间点，时间片开始时刻，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`。
Value	Integer	`211`	请求次数，单位为次。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXEdgeRequest&Version=2018-08-01&ServiceIds=s1,s2&DomainNames=d1,d2&Regions=中国大陆,北美区&UserCountry=中国&UserProvince=北京&Protocols=HTTP,HTTPS&Isp=移动,联通&DataTypes=req_cnt,2xx,3xx&GroupBy=DomainName,DataType&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300&DetailedCode=true

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXEdgeRequest",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "RequestCnt": [
            {
                "Data": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 123
                    }
                ],
                "DataType": "200",
                "DomainName": "d1"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	Missing Parameter.	请求参数错误
401	ParamAccountMismatch	Param {} did not belong to your account.	请求参数不属于账号
500	InternalError	Internal Error.	内部错误

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。