查询边缘分发地区列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询边缘分发地区列表

最近更新时间：2024.08.14 11:01:03首次发布时间：2024.04.08 17:49:22

本接口支持通过自定义查询时间段，查询该时间段的边缘分发数据的地区列表。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXEdgeRequestRegions`	接口名称。当前 API 的名称为 `DescribeImageXEdgeRequestRegions`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 90 天。
EndTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据结束时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 90 天。

返回参数

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

参数	类型	示例值	描述
UserProvince	Array of String	`["北京"]`	客户端省份
UserCountry	Array of String	`["中国"]`	客户端国家

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXEdgeRequestRegions&Version=2023-05-01&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXEdgeRequestRegions",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "UserProvince": [
            "北京"
        ],
        "UserCountry": [
            "中国"
        ]
    }
}

错误码

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