查询镜像回源请求次域名明细数据--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询镜像回源请求次域名明细数据

最近更新时间：2024.08.09 10:27:34首次发布时间：2023.01.03 19:11:01

本接口支持查询当前账号下镜像回源请求次的域名明细数据用量。

说明

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

注意事项

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

请求说明

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

说明

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

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXMirrorRequestHttpCodeOverview`	接口名称。`DescribeImageXMirrorRequestHttpCodeOverview`
Version	String	是	`2018-08-01`	接口版本

Body

参数	类型	是否必选	示例值	描述
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`。
AggregateCode	String	否	`true`	状态码是否聚合。支持取值如下： `true`：聚合 `false`：（默认）不聚合
ServiceIds	Array of String	否	`ys***,4q***`	服务 ID。为空时表示不筛选，支持查询多个服务，使用逗号分隔不同的服务。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考 GetAllImageServices。
DomainNames	Array of String	否	`xxx.com,yyy.com`	域名。为空时表示不筛选，支持查询多个域名，不同的域名使用逗号分隔。您可以通过调用 GetServiceDomains 获取服务下所有域名信息。

返回参数

参数	类型	示例值	描述
Data	Array of Data		具体数据

Data

参数	类型	示例值	描述
Domain	String	`xxx.com`	域名
Count	Integer	`172469515`	总请求次数，单位为次。
Details	Array of Details		详细数据

Details

参数	类型	示例值	描述
HttpCode	String	`2xx`	Http 状态码
Value	Integer	`171924591`	Http 状态码对应的请求次数，单位为次。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXMirrorRequestHttpCodeOverview&Version=2018-08-01
{
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-02T00:00:00+08:00",
    "ServiceIds": [
        "s1"
    ],
    "AggregateCode": "true",
    "DomainNames": [
        "xxx.com"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXMirrorRequestHttpCodeOverview",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "Domain": "xxx.com",
                "Count": 172469515,
                "Details": [
                    {
                        "HttpCode": "2xx",
                        "Value": 171924591
                    }
                ]
            }
        ]
    }
}

错误码

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

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

服务端 SDK

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