文档中心

查询上传分片速度

最近更新时间：2023.05.26 12:00:17

首次发布时间：2023.03.23 10:31:55

本接口支持通过指定查询时间段和时间粒度获取 2.0 模式下的上传分片速度。

说明

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

请求说明

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

说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	描述
Appid	String	否	应用 ID，默认为空，不传匹配账号下所有的 AppID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
AppVer	Array of String	否	需要匹配的 App 版本，不传则匹配 App 的所有版本。
OS	String	否	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
SdkVer	Array of String	否	需要匹配的 SDK 版本，不传则匹配所有版本。
Country	String	否	需要匹配的国家名称，不传则匹配所有国家，传`海外`匹配海外所有国家
Province	String	否	需要匹配的省份名称，不传则匹配所有省份
Isp	Array of String	否	需要匹配的运营商名称，不传则匹配所有运营商。支持取值如下： `电信` `联通` `移动` `铁通` `鹏博士` `教育网` `其他`
ExtraDims	Array of ExtraDims	否	需要匹配的自定义维度项
GroupBy	String	否	拆分维度。默认为空，表示拆分分位数据。支持取值： `Duration`：表示分位数据公共维度：`Appid`、`OS`、`AppVer`、`SdkVer`、`Country`、`Province`、`Isp` 自定义维度：您可以通过调用 GetImageXQueryDims接口获取自定义维度指标。
UploadType	Integer	是	上传类型，固定值传入`2`，表示上传 2.0 数据。
StartTime	String	是	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。起始时间与结束时间间隔小于等于 90 天。
EndTime	String	是	获取数据结束时间点，需在起始时间点之后。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。起始时间与结束时间间隔小于等于 90 天。
Granularity	String	是	返回数据的时间粒度，取值如下所示： `5m`：5 分钟 `1h`：1 小时 `1d`：1 天

ExtraDims

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

返回参数

参数	类型	描述
SpeedData	Array of SpeedData	上传速度数据。

SpeedData

参数类型描述

参数	类型	描述
Type	String	数据类型。 `GroupBy`为空或`Duration`时，取值为：pct25、pct50、pct90、pct99、avg `GroupBy`取值为其他时，表示指定拆分维度的各个值
Count	Integer	总上传次数
Data	Array of Data	具体数据

Type

String

数据类型。

GroupBy为空或Duration时，取值为：pct25、pct50、pct90、pct99、avg
GroupBy取值为其他时，表示指定拆分维度的各个值

Count Integer 总上传次数

Data Array of Data 具体数据

Data

参数	类型	描述
Count	Integer	上传次数
Timestamp	String	数据对应时间点，按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。
Value	Float	上传分片速度，单位为 KB/s。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXUploadSegmentSpeedByTime&Version=2018-08-01 
{
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-02T00:01:00+08:00",
    "Granularity": "1h",
    "Province": "xx",
    "ExtraDims": [
        {
            "Dim": "xx",
            "Vals": [
                "xx"
            ]
        }
    ],
    "GroupBy": "xx",
    "SdkVer": [
        "1.2.3"
    ],
    "AppVer": [
        "2.3.1"
    ],
    "Isp": [
        "电信"
    ],
    "Appid": "12**9u",
    "Country": "海外",
    "OS": "iOS"
}

正常返回示例

{
     "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXUploadSegmentSpeedByTime",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"        
    }
    "Result": {
        "SpeedData": [
            {
                "Data": [
                    {
                        "Timestamp": "2020-01-01T08:00:00+08:00",
                        "Value": 0.992,
                        "Count": 5661
                    }
                ],
                "Type": "Total",
                "Count": 1739
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXUploadSegmentSpeedByTime",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

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