获取边缘分发地区列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取边缘分发地区列表

最近更新时间：2024.08.09 10:27:34首次发布时间：2023.02.23 18:56:05

本接口支持查询账号下对应域名的边缘分发数据的地区列表。

说明

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

请求说明

接口名称：DescribeImageXEdgeRequestRegions
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageXEdgeRequestRegions&Version=2018-08-01
请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟在 5~10 min 之间。
单次查询的最大时间跨度： 90 天。

说明

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

请求参数

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

Query

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

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXEdgeRequestRegions",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "UserProvince": [
            "北京"
        ],
        "UserCountry": [
            "中国"
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXEdgeRequestRegions",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

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

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

服务端 SDK

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