查询错误码分布--veImageX-火山引擎

文档中心

立即注册

导航

查询错误码分布

最近更新时间：2024.08.09 10:27:33首次发布时间：2021.02.23 10:42:25

本接口支持通过指定查询维度，查询错误码详细数据，如：错误码内容、错误码数量和地域信息等。

说明

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

注意事项

请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制： 50 次/秒。
数据延迟：约 15 分钟。
单次查询的最大时间跨度：90 天。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

Query

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

Body

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

ExtraDims

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

返回参数

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

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

ErrorCodeData

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

Details

参数	类型	示例值	描述
ErrorCode	String	`-32`	错误码内容。
ErrorCodeDesc	String	`Unknown`	错误码的描述信息。
Value	Integer	`1`	错误码数量。

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXUploadErrorCodeAll&Version=2018-08-01
{
    "Appid": "123",
    "AppVer": [
        "1.0"
    ],
    "OS": "iOS",
    "SdkVer": [
        "1.1.0"
    ],
    "Country": "海外",
    "Province": "北京",
    "Isp": [
        "电信"
    ],
    "ExtraDims": [
        {
            "Dim": "access",
            "Vals": [
                "4g"
            ]
        }
    ],
    "GroupBy": "Isp",
    "UploadType": 2,
    "StartTime": "2019-06-27T13:00:00+08:00",
    "EndTime": "2019-06-27T15:00:00+08:00",
    "OrderBy": "Count",
    "OrderAsc": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXUploadErrorCodeAll",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ErrorCodeData": [
            {
                "Isp": "电信",
                "Value": 1,
                "Details": [
                    {
                        "ErrorCode": "-32",
                        "ErrorCodeDesc": "Unknown",
                        "Value": 1
                    }
                ]
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

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

veImageX