注意事项

请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：约为 15 分钟。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXClientFileSize`	接口名称。当前 API 的名称为 `DescribeImageXClientFileSize`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
Appid	String	否	`123`	应用 ID。默认为空，不传则匹配账号下的所有的 AppID。
				:::tip
				您可以通过调用获取应用列表的方式获取所需的 AppID。
				:::
AppVer	Array of String	否	`["1.2.0"]`	需要匹配的 App 版本，不传则匹配 App 的所有版本。
OS	String	否	`WEB`	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
				- `iOS`
				- `Android`
				- `WEB`
SdkVer	Array of String	否	`["1.2.0"]`	需要匹配的 SDK 版本，不传则匹配所有版本.
Country	String	否	`海外`	需要匹配的国家名称。
				* 不传则匹配所有国家。
				* 取值为`海外`时，匹配海外所有国家。
Province	String	否	`北京`	需要匹配的省份名称，不传则匹配所有省份。
Isp	Array of String	否	`["电信"]`	需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
				- `电信`
				- `联通`
				- `移动`
				- `铁通`
				- `鹏博士`
				- `教育网`
				- `其他`
Domain	Array of String	否	`["d1"]`	需要匹配的域名，不传则匹配所有域名。
ImageType	Array of String	否	`["PNG"]`	需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
				- `GIF`
				- `PNG`
				- `JPEG`
				- `HEIF`
				- `HEIC`
				- `WEBP`
				- `AWEBP`
				- `VVIC`
				- `其他`
ExtraDims	Array of ExtraDims	否	`-`	需要匹配的自定义维度项。
GroupBy	String	否	`OS`	拆分维度。默认为空，表示拆分分位数据。支持取值：
				- `Duration`：表示拆分分位数据
				- 公共维度：`Appid`、`OS`、`AppVer`、`SdkVer`、`ImageType`、`Country`、`Province`、`Isp`、`Domain`
				- 自定义维度：您可以通过调用获取自定义维度列表接口获取自定义维度指标
StartTime	String	是	`2019-06-27T13:00:00+08:00`	获取数据起始时间点。
				日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
EndTime	String	是	`2019-06-27T15:00:00+08:00`	获取数据结束时间点，需在起始时间点之后。
				日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Granularity	String	是	`1h`	返回数据的时间粒度。取值如下所示：
				* `5m`：5 分钟；
				* `1h`：1 小时；
				* `1d`：1 天。

ExtraDims

参数	类型	是否必选	示例值	描述
Dim	String	是	`access`	自定义维度名称。
				:::tip
				您可以通过调用获取自定义维度列表来获取。
				:::
Vals	Array of String	是	`["4g"]`	需要匹配的对应维度值
				:::tip
				您可以通过调用获取自定义维度值来获取。
				:::

返回参数

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

参数	类型	示例值	描述
FSizeData	Array of FSizeData	`-`	客户端文件大小分布数据。

FSizeData

参数	类型	示例值	描述
Type	String	`avg`	数据类型。
			当`GroupBy`为空或`Duration`时，取值avg/pct25/pct50/pct90/pct99/min/max，否则取值为指定拆分维度的各个值。
Count	Integer	`3`	该数据类型对应的总上报量。
Data	Array of Data	`-`	对应的文件大小数据列表。

Data

参数	类型	示例值	描述
Value	Float	`3672400`	文件大小，单位为 byte。
Count	Integer	`23`	数据对应的上报量。
Timestamp	String	`2023-01-01T00:00:00+08:00`	数据对应时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`。

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientFileSize&Version=2023-05-01&=
{
    "Appid": "123",
    "AppVer": [
        "1.2.0"
    ],
    "OS": "WEB",
    "SdkVer": [
        "1.2.0"
    ],
    "Country": "海外",
    "Province": "北京",
    "Isp": [
        "电信"
    ],
    "Domain": [
        "d1"
    ],
    "ImageType": [
        "PNG"
    ],
    "ExtraDims": [
        {
            "Dim": "access",
            "Vals": [
                "4g"
            ]
        }
    ],
    "GroupBy": "OS",
    "StartTime": "2019-06-27T13:00:00+08:00",
    "EndTime": "2019-06-27T15:00:00+08:00",
    "Granularity": "1h"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXClientFileSize",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "FSizeData": [
            {
                "Type": "avg",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            },
            {
                "Type": "pct25",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            },
            {
                "Type": "pct50",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            },
            {
                "Type": "pct90",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            },
            {
                "Type": "pct99",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            },
            {
                "Type": "min",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            },
            {
                "Type": "max",
                "Count": 123,
                "Data": [
                    {
                        "Value": 18,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            }
        ]
    }
}

错误码

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

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

服务端 SDK

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

历史版本

2018-08-01 版本 DescribeImageXClientFileSize 接口文档现已停止维护，建议您参考本文档使用最新版本。

最近更新时间：2024.08.13 20:23:51

这个页面对您有帮助吗？

有用

无用