You need to enable JavaScript to run this app.
导航
查询网络协议占比
最近更新时间:2023.05.26 12:00:15首次发布时间:2021.02.23 10:42:28

本接口支持通过指定查询维度,来获取下行网络监控的网络协议占比数据。

说明

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

请求说明

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

说明

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

Granularity

String

返回数据的时间粒度。

  • 5m:5 分钟;
  • 1h:1 小时;
  • 1d:1 天。

ExtraDims

参数类型是否必选描述

Dim

String

自定义维度名称。

说明

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

Vals

Array of String

需要匹配的对应维度值。

说明

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

返回参数

参数类型描述
ProtocolRateDataArray of ProtocolRateData各协议占比数据。

ProtocolRateData

参数类型描述

Type

String

网络协议类型。
取值为:http、https

CountInteger上报数据总量。
DataArray of Data对应的协议占比数据列表。

Data

参数类型描述
ValueFloat网络协议占比。
CountInteger上报数据量。

Timestamp

String

数据对应时间点。

  • 日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXCdnProtocolRateByTime&Version=2018-08-01
{
    "StartTime": "2020-11-27T13:00:00+08:00",
    "EndTime": "2020-11-27T15:00:00+08:00",
    "Granularity": "1h"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202012041802350100110600880B09B5F5",
        "Action": "DescribeImageXCdnProtocolRateByTime",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ProtocolRateData": [
            {
                "Type": "http",
                "Count": 45684856,
                "Data": [
                    {
                        "Value": 0.7574129949188799,
                        "Count": 24282853,
                        "Timestamp": "2020-11-27T13:00:00.000+08:00"
                    },
                    {
                        "Value": 0.7499356920247704,
                        "Count": 21402003,
                        "Timestamp": "2020-11-27T14:00:00.000+08:00"
                    }
                ]
            }
        ]
    }
}

异常返回示例

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

错误码

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