本接口支持通过指定查询维度,来获取下行网络监控的网络成功率分布数据。
说明
该接口属于历史版本 API,建议您使用新版 DescribeImageXCdnSuccessRateAll 接口。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。veImageX 当前 API 的版本为 2018-08-01 。 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Appid | String | 否 | 应用 ID。默认为空,不传则匹配账号下的所有的 App ID。 说明 您可以通过调用获取应用列表的方式获取所需的 AppID。 |
AppVer | Array of String | 否 | 需要匹配的 App 版本,不传则匹配 App 的所有版本。 |
OS | String | 否 | 需要匹配的系统类型,不传则匹配所有非 WEB 端的系统。取值如下所示:
|
SdkVer | Array of String | 否 | 需要匹配的 SDK 版本,不传则匹配所有版本。 |
Country | String | 否 | 需要匹配的国家名称。
|
Province | String | 否 | 需要匹配的省份名称,不传则匹配所有省份。 |
Isp | Array of String | 否 | 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下:
|
Domain | Array of String | 否 | 需要匹配的域名,不传则匹配所有域名。 |
ImageType | Array of String | 否 | 需要匹配的图片类型,不传则匹配所有图片类型。
|
ExtraDims | Array of ExtraDims | 否 | 需要匹配的自定义维度项。 |
StartTime | String | 是 | 获取数据起始时间点。 |
EndTime | String | 是 | 获取数据结束时间点,需在起始时间点之后。 |
GroupBy | String | 是 | 聚合维度。
|
OrderBy | String | 否 |
|
OrderAsc | Boolean | 否 | 是否升序排序。不传则默认降序排序。 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Dim | String | 是 | 自定义维度名称。 说明 您可以通过调用获取自定义维度列表来获取。 |
Vals | Array of String | 是 | 需要匹配的对应维度值。 说明 您可以通过调用获取自定义维度值来获取。 |
参数 | 类型 | 描述 |
---|---|---|
SuccessRateData | Array of SuccessRateData | 网络成功率数据。 |
参数 | 类型 | 描述 |
---|---|---|
Region | String | 当GroupBy 取值Region 时出现,表示地区信息。 |
RegionType | String | 当
|
Isp | String | 当GroupBy 取值Isp 时出现,则表示运营商信息。 |
Domain | String | 当GroupBy 取值Domain 时出现,则表示域名信息。 |
Value | Float | 网络成功率。 |
Count | Integer | 上报数据量。 |
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": "" } } }