最近更新时间:2023.05.26 12:00:14
首次发布时间:2021.02.23 10:42:25
本接口支持通过指定查询维度,查询错误码详细数据,如:错误码内容、错误码数量和地域信息等。
说明
单次查询的时间跨度不能超过 90 天。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。veImageX 当前 API 的版本为 2018-08-01 。 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Appid | String | 否 | 应用 ID。默认为空,匹配账号下所有的 App ID。 说明 您可以通过调用获取应用列表的方式获取所需的 AppID。 |
AppVer | Array of String | 否 | 需要匹配的 App 版本,不传则匹配 App 的所有版本。 |
OS | String | 否 | 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:
|
SdkVer | Array of String | 否 | 需要匹配的 SDK 版本,不传则匹配所有版本。 |
Country | String | 否 | 需要匹配的国家名称。
|
Province | String | 否 | 需要匹配的省份名称,不传则匹配所有省份。 |
Isp | Array of String | 否 | 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下:
|
ExtraDims | Array of ExtraDims | 否 | 需要匹配的自定义维度项。 |
UploadType | Integer | 否 | 上传类型,默认为空,返回上传 1.0 数据。
|
StartTime | String | 是 | 获取数据起始时间点。
|
EndTime | String | 是 | 获取数据结束时间点,需在起始时间点之后。
|
GroupBy | String | 是 | 聚合维度。
|
OrderBy | String | 否 | 目前仅支持传入Count 按错误码数量排序。不传或者传空默认按错误码数量排序。 |
OrderAsc | Bool | 否 | 是否升序排序。不传则默认为 false,表示降序排序。 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Dim | String | 是 | 自定义维度名称。 说明 您可以通过调用获取自定义维度列表来获取。 |
Vals | Array of String | 是 | 需要匹配的对应维度值。 说明 您可以通过调用获取自定义维度值来获取。 |
参数 | 类型 | 描述 |
---|---|---|
ErrorCodeData | Array of ErrorCodeData | 错误码数据。 |
参数 | 类型 | 描述 |
---|---|---|
ErrorCode | String | 当GroupBy 取值ErrorCode 时出现,表示错误码内容。 |
ErrorCodeDesc | String | 当GroupBy 取值ErrorCode 时出现,表示错误码的描述信息。 |
Region | String | 当GroupBy 取值Region 时出现,表示地区信息。 |
RegionType | String | 当
|
Isp | String | 当GroupBy 取值Isp 时出现,则表示运营商信息。 |
Value | Integer | 错误码数量。 |
Details | Array of Details | 当GroupBy 取值非ErrorCode 时出现,表示错误码详细信息。 |
参数 | 类型 | 描述 |
---|---|---|
ErrorCode | String | 错误码内容。 |
ErrorCodeDesc | String | 错误码的描述信息。 |
Value | Integer | 错误码数量。 |
POST https://imagex.volcengineapi.com/?Action=DescribeImageXUploadErrorCodeAll&Version=2018-08-01 { "StartTime": "2019-06-27T13:00:00+08:00", "EndTime": "2019-06-27T15:00:00+08:00", "GroupBy": "Isp" }
{ "ResponseMetadata": { "RequestId": "2019062716063601022507408223311", "Action": "DescribeImageXUploadErrorCodeAll", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "ErrorCodeData": [ { "Isp": "其他", "Value": 2, "Details": [ { "ErrorCode": "-5", "ErrorCodeDesc": "Unknown", "Value": 1 }, { "ErrorCode": "-32", "ErrorCodeDesc": "Unknown", "Value": 1 } ] } ] } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeImageXUploadErrorCodeAll", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1", "Error": { "Code": "", "Message": "" } } }