本接口支持通过指定查询维度,来获取上传数据中的上传平均速度数据。
说明
该接口属于历史版本 API,建议您使用新版 DescribeImageXUploadSpeed 接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | String | 是 | application/json | 请求头字段 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXUploadSpeed | 接口名称。当前 API 的名称为 DescribeImageXUploadSpeed 。 |
Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Appid | String | 否 |
| 应用 ID。默认为空,不传则匹配账号下的所有的 App ID。 说明 您可以通过调用获取应用列表的方式获取所需的 AppID。 |
AppVer | Array of String | 否 | 需要匹配的 App 版本,不传则匹配 App 的所有版本。 | |
OS | String | 否 |
| 需要匹配的系统类型。取值如下所示:
|
SdkVer | Array of String | 否 | 需要匹配的 SDK 版本,不传则匹配所有版本。 | |
Country | String | 否 |
| 需要匹配的国家名称。
|
Province | String | 否 | 北京 | 需要匹配的省份名称,不传则匹配所有省份。 |
Isp | Array of String | 否 | 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下:
| |
ExtraDims | Array of ExtraDims | 否 | 需要匹配的自定义维度项。 | |
GroupBy | String | 否 |
| 拆分维度。默认为空,表示拆分分位数据。 支持取值:
|
UploadType | Integer | 否 |
| 上传类型,默认为空,返回上传 1.0 数据。
|
StartTime | String | 是 |
| 获取数据起始时间点。 |
EndTime | String | 是 |
| 获取数据结束时间点,需在起始时间点之后。 |
Granularity | String | 是 |
| 返回数据的时间粒度。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Dim | String | 是 |
| 自定义维度名称。 说明 您可以通过调用获取自定义维度列表来获取。 |
Vals | Array of String | 是 | 需要匹配的对应维度值。 说明 您可以通过调用获取自定义维度值来获取。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SpeedData | Array of SpeedData | 上传速度数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String |
| 数据类型。
|
Count | Integer | 123 | 对应的总次数。 |
Data | Array of Data | 对应的上传速度数据列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Count | Integer | 123 | 数据对应上传次数。 |
Timestamp | String |
| 数据对应时间点。
|
Value | Float | 456.7 | 平均速度,单位为 KB/s。 |
POST https://imagex.volcengineapi.com/?Action=DescribeImageXUploadSpeed&Version=2018-08-01 { "Appid": "123", "AppVer": [ "1.0" ], "OS": "iOS", "SdkVer": [ "1.1.0" ], "Country": "海外", "Province": "北京", "Isp": [ "电信" ], "ExtraDims": [ { "Dim": "access", "Vals": [ "4g" ] } ], "GroupBy": "OS", "UploadType": 2, "StartTime": "2019-06-27T13:00:00+08:00", "EndTime": "2019-06-27T15:00:00+08:00", "Granularity": "1h" }
{ "ResponseMetadata": { "RequestId": "202306041104200100100232280022D31", "Action": "DescribeImageXUploadSpeed", "Version": "2018-08-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "SpeedData": [ { "Type": "iOS", "Count": 123, "Data": [ { "Count": 123, "Timestamp": "2023-01-01T00:00:00+08:00", "Value": 456 } ] }, { "Type": "Android", "Count": 234, "Data": [ { "Count": 234, "Timestamp": "2023-01-01T00:00:00+08:00", "Value": 789 } ] } ] } }
本接口无特有的错误码。更多信息请见公共错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter | Missing Parameter. | 请求参数错误 |
401 | ParamAccountMismatch | Param {} did not belong to your account. | 请求参数不属于账号 |
500 | InternalError | Internal Error. | 内部错误 |