You need to enable JavaScript to run this app.
导航
查询错误码分布
最近更新时间: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

调试

请求参数

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

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

Query

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

Body

参数类型是否必选示例值描述

Appid

String

123

应用 ID。默认为空,不传则匹配账号下的所有的 App ID。

说明

您可以通过调用获取应用列表的方式获取所需的 AppID。

AppVerArray of String需要匹配的 App 版本,不传则匹配 App 的所有版本。

OS

String

iOS

需要匹配的系统类型。取值如下所示:

  • 不传或传空字符串:Android+iOS。
  • iOS:iOS。
  • Android:Android。
  • WEB:web+小程序。
  • Web:web。
  • Imp:小程序。
SdkVerArray of String需要匹配的 SDK 版本,不传则匹配所有版本。

Country

String

海外

需要匹配的国家名称。

  • 不传则匹配所有国家。
  • 取值为海外时,匹配海外所有国家。
ProvinceString北京需要匹配的省份名称,不传则匹配所有省份。

Isp

Array of String

需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下:

  • 电信
  • 联通
  • 移动
  • 铁通
  • 鹏博士
  • 教育网
  • 其他
ExtraDimsArray 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

OrderByStringCount目前仅支持传入Count按错误码数量排序。不传或者传空默认按错误码数量排序。
OrderAscBooleanfalse是否升序排序。不传则默认为 false,表示降序排序。

ExtraDims

参数类型是否必选示例值描述

Dim

String

access

自定义维度名称。

说明

您可以通过调用获取自定义维度列表来获取。

Vals

Array of String

需要匹配的对应维度值。

说明

您可以通过调用获取自定义维度值来获取。

返回参数

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

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

ErrorCodeData

参数类型示例值描述
ErrorCodeString-5GroupBy取值ErrorCode时出现,表示错误码内容。
ErrorCodeDescStringUnknownGroupBy取值ErrorCode时出现,表示错误码的描述信息。
RegionString中国GroupBy取值Region时出现,表示地区信息。

RegionType

String

Country

GroupBy取值Region时出现,表示地区类型。

  • Country:国家;
  • Province:省份。
IspString电信GroupBy取值Isp时出现,则表示运营商信息。
ValueInteger2错误码数量。
DetailsArray of DetailsGroupBy取值ErrorCode时出现,表示错误码详细信息。

Details

参数类型示例值描述
ErrorCodeString-32错误码内容。
ErrorCodeDescStringUnknown错误码的描述信息。
ValueInteger1错误码数量。

请求示例

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
                    }
                ]
            }
        ]
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameterMissing Parameter.请求参数错误
401ParamAccountMismatchParam {} did not belong to your account.请求参数不属于账号
500InternalErrorInternal Error.内部错误