文档中心

查询错误码分布

最近更新时间：2023.05.26 12:00:14

首次发布时间：2021.02.23 10:42:25

本接口支持通过指定查询维度，来获取下行网络监控的错误码分布数据。

说明

单次查询的时间跨度不能超过 90 天。

请求说明

接口名称：DescribeImageXCdnErrorCodeAll
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageXCdnErrorCodeAll&Version=2018-08-01
请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟为 15 min。

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数	类型	是否必选	描述
Appid	String	否	应用 ID。默认为空，不传则匹配账号下的所有的 App ID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
AppVer	Array of String	否	需要匹配的 App 版本，不传则匹配 App 的所有版本。
OS	String	否	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
SdkVer	Array of String	否	需要匹配的 SDK 版本，不传则匹配所有版本。
Country	String	否	需要匹配的国家名称。不传则匹配所有国家。取值为`海外`时，匹配海外所有国家。
Province	String	否	需要匹配的省份名称，不传则匹配所有省份。
Isp	Array of String	否	需要匹配的运营商名称，不传则匹配所有运营商。支持取值如下： `电信` `联通` `移动` `铁通` `鹏博士` `教育网` `其他`
Domain	Array of String	否	需要匹配的域名，不传则匹配所有域名。
ImageType	Array of String	否	需要匹配的图片类型，不传则匹配所有图片类型。 `GIF` `PNG` `JPEG` `HEIF` `HEIC` `WEBP` `AWEBP` `VVIC` `其他`
ExtraDims	Array of ExtraDims	否	需要匹配的自定义维度项。
StartTime	String	是	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
EndTime	String	是	获取数据结束时间点，需在起始时间点之后。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
GroupBy	String	是	聚合维度。 `Domain`：域名； `ErrorCode`：错误码； `Region`：地区； `Isp`：运营商。
OrderBy	String	否	目前仅支持传入`Count`按错误码数量排序。不传或者传空默认按错误码数量排序。
OrderAsc	Boolean	否	是否升序排序。不传则默认降序排序，默认降序排序。

ExtraDims

参数	类型	是否必选	描述
Dim	String	是	自定义维度名称。说明您可以通过调用获取自定义维度列表来获取。
Vals	Array of String	是	需要匹配的对应维度值。说明您可以通过调用获取自定义维度值来获取。

返回参数

参数	类型	描述
ErrorCodeData	Array of ErrorCodeData	错误码数据。

ErrorCodeData

参数	类型	描述
ErrorCode	String	当`GroupBy`取值`ErrorCode`时出现，表示错误码内容。
ErrorCodeDesc	String	当`GroupBy`取值`ErrorCode`时出现，表示错误码的描述信息。
Region	String	当`GroupBy`取值`Region`时出现，表示地区信息。
RegionType	String	当`GroupBy`取值`Region`时出现，表示地区类型。取值`Country`时，表示国家；取值`Province`时，表示省份。
Isp	String	当`GroupBy`取值`Isp`时出现，则表示运营商信息。
Domain	String	当`GroupBy`取值`Domain`时出现，则表示域名信息。
Value	Integer	错误码数量。
Details	Array of Details	当`GroupBy`取值非`ErrorCode`时出现，表示错误码详细信息。

Details

参数	类型	描述
ErrorCode	String	错误码内容。
ErrorCodeDesc	String	错误码的描述信息。
Value	Integer	错误码数量。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXCdnErrorCodeAll&Version=2018-08-01
{
        "StartTime": "2019-06-27T13:00:00+08:00",
        "EndTime": "2019-06-27T15:00:00+08:00",
        "GroupBy": "Isp"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019062717454201022507408237138",
        "Action": "DescribeImageXCdnErrorCodeAll",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ErrorCodeData": [
            {
                "Isp": "移动",
                "Value": 647,
                "Details": [
                    "ErrorCode": "-10",
                    "ErrorCodeDesc": "xxx",
                    "Value": 647
                ]
            },
            {
                "Isp": "电信",
                "Value": 517,
                "Details": [
                    "ErrorCode": "-10",
                    "ErrorCodeDesc": "xxx",
                    "Value": 517
                ]
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "DescribeImageXCdnErrorCodeAll",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

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