You need to enable JavaScript to run this app.
导航
查询文件大小 TOP URL
最近更新时间:2024.04.12 15:11:29首次发布时间:2024.04.12 15:11:29

本接口支持通过指定查询维度,来获取客户端状态监控的文件大小 TOP URL。

注意事项

  • 请求频率:单用户请求频率限制为 50 次/秒
  • 数据延迟:约为 4 小时
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=DescribeImageXClientTopFileSize&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeImageXClientTopFileSize接口名称。当前 API 的名称为 DescribeImageXClientTopFileSize
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

Body

参数类型是否必选示例值描述
AppidString123应用 ID。默认为空,不传则匹配账号下的所有的 App ID。您可以通过调用获取应用列表的方式获取所需的 AppID。

OS

String

iOS

需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:

  • iOS
  • Android
  • WEB
StartTimeString2020-11-27T13:00:00+08:00获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
EndTimeString2020-11-30T15:00:00+08:00获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
TopInteger1000查询 Top URL 条数,取值范围为[0,1000],默认值为 1000。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
TopUrlDataArray of TopUrlData-Top URL 数据

TopUrlData

参数类型示例值描述
UrlStringhttp://xxx.byteimg.com/xxxx~tplv-shrink:480:600.awebp文件 URL
ValueFloat129984549文件大小,单位为 byte
CountInteger1上报数据量

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientTopFileSize&Version=2023-05-01&=
{
    "Appid": "123",
    "OS": "iOS",
    "StartTime": "2020-11-27T13:00:00+08:00",
    "EndTime": "2020-11-30T15:00:00+08:00",
    "Top": 1000
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXClientTopFileSize",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TopUrlData": [
            {
                "Url": "http://xxx.byteimg.com/xxxx~tplv-shrink:480:600.awebp",
                "Value": 129984549,
                "Count": 1
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码

状态码错误码错误信息说明
400InvalidParameterMissing Parameter.请求参数错误,请检查您的请求参数是否正确。
401ParamAccountMismatchParam {} did not belong to your account.请求参数不属于账号,请检查您的请求参数是否正确。
500InternalErrorInternal Error.内部错误,请提交工单联系技术支持。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。