You need to enable JavaScript to run this app.
导航
查询网络成功率分布
最近更新时间:2024.08.09 10:27:33首次发布时间:2021.02.23 10:42:25

本接口支持通过指定查询维度,来获取下行网络监控的网络成功率分布数据。

说明

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

请求说明

  • 接口名称:DescribeImageXCdnSuccessRateAll
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=DescribeImageXCdnSuccessRateAll&Version=2018-08-01
  • 请求频率:
    • API 整体的请求频率限制为 100 次/秒
    • 单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟为 15 min
  • 单次查询的最大时间跨度为 90 天。

说明

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

请求参数

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

Query

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

Body

参数类型是否必选描述

Appid

String

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

说明

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

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

OS

String

需要匹配的系统类型,不传则匹配所有非 WEB 端的系统。取值如下所示:

  • iOS
  • Android
  • WEB
SdkVerArray of String需要匹配的 SDK 版本,不传则匹配所有版本。

Country

String

需要匹配的国家名称。

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

Isp

Array of String

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

  • 电信
  • 联通
  • 移动
  • 铁通
  • 鹏博士
  • 教育网
  • 其他
DomainArray of String需要匹配的域名,不传则匹配所有域名。

ImageType

Array of String

需要匹配的图片类型,不传则匹配所有图片类型。

  • GIF
  • PNG
  • JPEG
  • HEIF
  • HEIC
  • WEBP
  • AWEBP
  • VVIC
  • 其他
ExtraDimsArray 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:域名;
  • Region:地区;
  • Isp:运营商。

OrderBy

String

  • 取值为SuccessRate时,表示按网络成功率排序;
  • 取值为Count时,表示按上报量排序;
  • 不传或者传空默认按上报量排序。
OrderAscBoolean是否升序排序。不传则默认降序排序。

ExtraDims

参数类型是否必选描述

Dim

String

自定义维度名称。

说明

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

Vals

Array of String

需要匹配的对应维度值。

说明

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

返回参数

参数类型描述
SuccessRateDataArray of SuccessRateData网络成功率数据。

SuccessRateData

参数类型描述
RegionStringGroupBy取值Region时出现,表示地区信息。

RegionType

String

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

  • 取值Country,表示国家;
  • 取值Province,表示省份。
IspStringGroupBy取值Isp时出现,则表示运营商信息。
DomainStringGroupBy取值Domain时出现,则表示域名信息。
ValueFloat网络成功率。
CountInteger上报数据量。

示例

请求示例

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

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019062717440001022507408266968",
        "Action": "DescribeImageXCdnSuccessRateAll",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "SuccessRateData": [
            {
                "Isp": "教育网",
                "Value": 0.9954545454545455,
                "Count": 440
            },
            {
                "Isp": "鹏博士",
                "Value": 0.9932935916542474,
                "Count": 5368
            },
            {
                "Isp": "电信",
                "Value": 0.9932852830653607,
                "Count": 259728
            }
        ]
    }
}

异常返回示例

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

错误码

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