You need to enable JavaScript to run this app.
导航

查询内存/磁盘命中率

最近更新时间2023.05.26 12:00:16

首次发布时间2023.01.03 19:26:26

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

说明

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

请求说明

  • 接口名称:DescribeImageXSensibleCacheHitRateByTime
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleCacheHitRateByTime&Version=2018-08-01
  • 请求频率:
    • API 整体的请求频率限制为 100 次/秒
    • 单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟约为 15 min

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

Body

参数类型是否必选描述

Appid

String

应用 ID,缺省情况下匹配账号下所有 AppID。

说明

您可以通过调用获取应用列表的方式获取所需的 AppID。

OS

String

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

  • iOS
  • Android
  • WEB
AppVerArray of String需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
SdkVerArray of String需要匹配的 SDK 版本,缺省情况下则匹配所有版本。

ImageType

Array of String

需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值:

  • GIF
  • PNG
  • JPEG
  • HEIF
  • HEIC
  • WEBP
  • AWEBP
  • VVIC
  • 其他
ExtraDimsArray of ExtraDims需要匹配的自定义维度项。

GroupBy

String

拆分维度。默认为空,不拆分。支持取值:

  • 公共维度:AppidOSAppVerSdkVerImageType
  • 自定义维度:您可以通过调用 GetImageXQueryDims接口获取自定义维度指标

Type

String

缓存类型。支持以下取值:

  • 1:查询内存命中率数据;
  • 2:查询磁盘命中率数据。

StartTime

String

获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,例如2019-06-02T00:00:00+08:00
起始时间与结束时间间隔小于等于 90 天。

EndTime

String

获取数据结束时间点,需在起始时间点之后。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,例如2019-06-02T00:00:00+08:00
起始时间与结束时间间隔小于等于 90 天。

Granularity

String

返回数据的时间粒度,支持以下取值:

  • 5m:5分钟;
  • 1h:1小时;
  • 1d:1天。

ExtraDims

参数类型是否必选描述

Dim

String

自定义维度名称。

说明

您可以通过调用获取自定义维度列表来获取。

Vals

Array of String

需要匹配的对应维度值。

说明

您可以通过调用获取自定义维度值来获取。

返回参数

参数类型描述
CacheHitDataArray of CacheHitData命中率数据

CacheHitData

参数类型描述
TypeString数据类型,不拆分时值为Total,拆分时为具体的维度值。
CountInteger该数据类型对应的总上报量。
DataArray of Data具体数据

Data

参数类型描述
ValueFloat内存/磁盘命中率。
CountInteger数据对应的上报量。
TimestampString数据对应时间点,按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。

示例

请求示例

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

正常返回示例

{
		"ResponseMetadata": {
       "RequestId": "201806041104200100100232280022D30",
       "Action": "DescribeImageXSensibleCacheHitRateByTime",
       "Version": "2018-08-01",
       "Service": "imagex",
       "Region": "cn-north-1"
    }
    "Result": {
        "CacheHitData": [
            {
                "Type": "Total",
                "Count": 6054,
                "Data": [
                    {
                        "Count": 6054,
                        "Timestamp": "2020-01-01T08:00:00+08:00",
                        "Value": 0.11292
                    }
                ]
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXSensibleCacheHitRateByTime",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问错误码获取详细信息。