文档中心

查询内存/磁盘命中率

最近更新时间：2024.04.12 15:11:29

首次发布时间：2024.04.12 15:11:29

本接口支持查询感知指标内存/磁盘命中率数据。

说明

单次查询的时间跨度不能超过 90 天。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Appid	String	否	`123`	应用 ID，缺省情况下匹配账号下所有 AppID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	`Android`	需要匹配的系统类型，缺省情况下匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
AppVer	Array of String	否	`["1.0.0"]`	需要匹配 App 版本，缺省情况下则匹配 App 的所有版本。
SdkVer	Array of String	否	`["1.0.0"]`	需要匹配的 SDK 版本，缺省情况下则匹配所有版本。
ImageType	Array of String	否	`["PNG"]`	需要匹配的图片类型，缺省情况下则匹配所有图片类型。支持以下取值： `GIF` `PNG` `JPEG` `HEIF` `HEIC` `WEBP` `AWEBP` `VVIC` `其他`
ExtraDims	Array of ExtraDims	否	`-`	需要匹配的自定义维度项。
GroupBy	String	否	`OS`	拆分维度。默认为空，不拆分。支持取值：公共维度：`Appid`、`OS`、`AppVer`、`SdkVer`、`ImageType` 自定义维度：您可以通过调用获取自定义维度列表接口获取自定义维度指标
Type	String	是	`1`	缓存类型。支持以下取值： `1`：查询内存命中率数据； `2`：查询磁盘命中率数据。
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，例如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 90 天。
EndTime	String	是	`2019-06-03T00:00:00+08:00`	获取数据结束时间点，需在起始时间点之后。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，例如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 90 天。
Granularity	String	是	`5m`	返回数据的时间粒度，支持以下取值： `5m`：5分钟； `1h`：1小时； `1d`：1天。

ExtraDims

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

返回参数

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

参数	类型	示例值	描述
CacheHitData	Array of CacheHitData	`-`	命中率数据

CacheHitData

参数	类型	示例值	描述
Type	String	`Total`	数据类型，不拆分时值为`Total`，拆分时为具体的维度值。
Count	Integer	`3`	该数据类型对应的总上报量。
Data	Array of Data	`-`	具体数据

Data

参数	类型	示例值	描述
Value	Float	`0.11297`	内存/磁盘命中率。
Count	Integer	`3`	数据对应的上报量。
Timestamp	String	`2023-01-01T00:00:00+08:00`	数据对应时间点，按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleCacheHitRateByTime&Version=2023-05-01&=
{
    "Appid": "123",
    "OS": "Android",
    "AppVer": [
        "1.0.0"
    ],
    "SdkVer": [
        "1.0.0"
    ],
    "ImageType": [
        "PNG"
    ],
    "ExtraDims": [
        {
            "Dim": "country",
            "Vals": [
                "中国"
            ]
        }
    ],
    "GroupBy": "OS",
    "Type": "1",
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-03T00:00:00+08:00",
    "Granularity": "5m"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXSensibleCacheHitRateByTime",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "CacheHitData": [
            {
                "Type": "Total",
                "Count": 3,
                "Data": [
                    {
                        "Value": 0.11297,
                        "Count": 3,
                        "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。