本接口支持通过指定查询维度,来获取客户端状态监控的降级率 TOP URL 数据明细。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | String | 是 | application/json | 请求头字段 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXClientTopDemotionURL | 接口名称。当前 API 的名称为 DescribeImageXClientTopDemotionURL 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Appid | String | 否 | 123 | 应用 ID。默认为空,不传则匹配账号下的所有的 AppID。您可以通过调用获取应用列表的方式获取所需的 AppID。 |
OS | String | 否 |
| 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:
|
DemotionType | String | 是 |
| 降级类型。取值如下所示:
|
StartTime | String | 是 | 2023-01-01T00:00:00+08:00 | 获取数据起始时间点。日期格式按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm ,比如2019-06-02T00:00:00+08:00 。 |
EndTime | String | 是 | 2023-01-01T00:00:00+08:00 | 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm ,比如2019-06-02T00:00:00+08:00 。 |
Top | Integer | 否 | 1000 | 查询 Top URL 条数,取值范围为[0,1000],默认值为 1000。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TopUrlData | Array of TopUrlData | - | Top URL 数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Url | String | http://xxx.xxx | 文件 URL |
Count | Integer | 96 | 上报数据量 |
POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientTopDemotionURL&Version=2023-05-01&= { "Appid": "123", "OS": "iOS", "DemotionType": "heic", "StartTime": "2023-01-01T00:00:00+08:00", "EndTime": "2023-01-01T00:00:00+08:00", "Top": 1000 }
{ "ResponseMetadata": { "RequestId": "202306041104200100100232280022D31", "Action": "DescribeImageXClientTopDemotionURL", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "TopUrlData": [ { "Url": "http://xxx.xxx", "Count": 96 } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter | Missing Parameter. | 请求参数错误,请检查您的请求参数是否正确。 |
401 | ParamAccountMismatch | Param {} did not belong to your account. | 请求参数不属于账号,请检查您的请求参数是否正确。 |
500 | InternalError | Internal Error. | 内部错误,请提交工单联系技术支持。 |
veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。
2018-08-01 版本 DescribeImageXClientTopDemotionURL 接口文档现已停止维护,建议您参考本文档使用最新版本。