You need to enable JavaScript to run this app.
导航
感知指标监控
最近更新时间:2024.06.03 19:01:59首次发布时间:2024.06.03 19:01:59

阅读本文,您可以获取 Node SDK 感知指标监控的接口调用示例,实现快速开发。

说明

本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。

调用说明

  • 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
  • 接口的参数说明和错误码等信息可通过接口文档查看。

前提条件

调用接口前,请先完成 Node SDK 的安装及初始化操作。

调用示例

本节为您介绍感知指标监控相关接口的功能和调用示例。

查询采集样本量

您可以调用 DescribeImageXSensibleCountByTime 接口查询采集样本量。详细的参数说明可参见 DescribeImageXSensibleCountByTime 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function DescribeImageXSensibleCountByTimeDemo () {
    try {
      const imagexService = new imagex.ImagexService({
        // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        accessKeyId: process.env.VOLC_ACCESSKEY,
        // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        secretKey: process.env.VOLC_SECRETKEY,
      });
      const requestParam = {
      // 应用 ID,缺省情况下匹配账号下所有 AppID。
      // note:
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/19511)的方式获取所需的 AppID。
      "Appid": "123",
      // 需要匹配的系统类型,缺省情况下匹配非 WEB 端的所有系统。取值如下所示:
      // <li> `iOS` </li>
      // <li> `Android` </li>
      // <li> `WEB` </li>
      "OS": "Android",
      // 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
      "AppVer" : ["1.0.0"], 
      // 需要匹配的 SDK 版本,缺省情况下则匹配所有版本。
      "SdkVer" : ["1.0.0"], 
      // 需要匹配的图片类型,缺省情况下则匹配所有图片类型。取值如下所示:
      // <li> `GIF` </li>
      // <li> `PNG` </li>
      // <li> `JPEG` </li>
      // <li> `HEIF` </li>
      // <li> `HEIC` </li>
      // <li> `WEBP` </li>
      // <li> `AWEBP` </li>
      // <li> `VVIC` </li>
      // <li> `其他` </li>
      "ImageType" : ["PNG"], 
      // 需要匹配的自定义维度项。
      "ExtraDims" : [ 
          {
            // 自定义维度名称。
            // note:
            // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。
            "Dim": "country",
            // 需要匹配的对应维度值。
            // note:
            // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
            "Vals" : ["中国"], 
          } 
      ], 
      // 拆分维度。默认为空,不拆分。支持取值:
      // <li> 公共维度:`Appid`、`OS`、`AppVer`、`SdkVer`、`ImageType` </li>
      // <li> 自定义维度:您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      "GroupBy": "OS",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,例如`2019-06-02T00:00:00+08:00`。
      // 起始时间与结束时间间隔小于等于 90 天。
      "StartTime": "2019-06-02T00:00:00+08:00",
      // 获取数据结束时间点,需在起始时间点之后。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,例如`2019-06-02T00:00:00+08:00`。
      // 起始时间与结束时间间隔小于等于 90 天。
      "EndTime": "2019-06-03T00:00:00+08:00",
      // 返回数据的时间粒度,取值如下所示:
      // <li> `5m`:5分钟; </li>
      // <li> `1h`:1小时; </li>
      // <li> `1d`:1天。 </li>
      "Granularity": "5m",
    }

      const res = await imagexService.DescribeImageXSensibleCountByTime(requestParam);
      console.log('res',res)
    } catch (err) {
      console.error(err);
    }
  }
    

查询内存/磁盘命中率

您可以调用 DescribeImageXSensibleCacheHitRateByTime 接口查询内存/磁盘命中率。详细的参数说明可参见 DescribeImageXSensibleCacheHitRateByTime 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function DescribeImageXSensibleCacheHitRateByTimeDemo () {
    try {
      const imagexService = new imagex.ImagexService({
        // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        accessKeyId: process.env.VOLC_ACCESSKEY,
        // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        secretKey: process.env.VOLC_SECRETKEY,
      });
      const requestParam = {
      // 应用 ID,缺省情况下匹配账号下所有 AppID。
      // note:
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      "Appid": "123",
      // 需要匹配的系统类型,缺省情况下匹配非 WEB 端的所有系统。取值如下所示:
      // <li> `iOS` </li>
      // <li> `Android` </li>
      // <li> `WEB` </li>
      "OS": "Android",
      // 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
      "AppVer" : ["1.0.0"], 
      // 需要匹配的 SDK 版本,缺省情况下则匹配所有版本。
      "SdkVer" : ["1.0.0"], 
      // 需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值:
      // <li> `GIF` </li>
      // <li> `PNG` </li>
      // <li> `JPEG` </li>
      // <li> `HEIF` </li>
      // <li> `HEIC` </li>
      // <li> `WEBP` </li>
      // <li> `AWEBP` </li>
      // <li> `VVIC` </li>
      // <li> `其他` </li>
      "ImageType" : ["PNG"], 
      // 需要匹配的自定义维度项。
      "ExtraDims" : [ 
          {
            // 自定义维度名称。
            // note:
            // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。
            "Dim": "country",
            // 需要匹配的对应维度值。
            // note:
            // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213048)来获取。
            "Vals" : ["中国"], 
          } 
      ], 
      // 拆分维度。默认为空,不拆分。支持取值:
      // <li> 公共维度:`Appid`、`OS`、`AppVer`、`SdkVer`、`ImageType` </li>
      // <li> 自定义维度:您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      "GroupBy": "OS",
      // 缓存类型。支持以下取值:
      // <li> `1`:查询内存命中率数据; </li>
      // <li> `2`:查询磁盘命中率数据。 </li>
      "Type": "1",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,例如`2019-06-02T00:00:00+08:00`。
      // 起始时间与结束时间间隔小于等于 90 天。
      "StartTime": "2019-06-02T00:00:00+08:00",
      // 获取数据结束时间点,需在起始时间点之后。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,例如`2019-06-02T00:00:00+08:00`。
      // 起始时间与结束时间间隔小于等于 90 天。
      "EndTime": "2019-06-03T00:00:00+08:00",
      // 返回数据的时间粒度,支持以下取值:
      // <li> `5m`:5分钟; </li>
      // <li> `1h`:1小时; </li>
      // <li> `1d`:1天。 </li>
      "Granularity": "5m",
    }

      const res = await imagexService.DescribeImageXSensibleCacheHitRateByTime(requestParam);
      console.log('res',res)
    } catch (err) {
      console.error(err);
    }
  }