You need to enable JavaScript to run this app.
导航
命中率
最近更新时间:2024.06.03 19:02:00首次发布时间:2024.06.03 19:02:00

阅读本文,您可以获取 Node SDK 命中率的接口调用示例,实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍命中率相关接口的功能和调用示例。

查询流量命中率

您可以调用 DescribeImageXHitRateTrafficData 接口查询流量命中率。详细的参数说明可参见 DescribeImageXHitRateTrafficData 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function DescribeImageXHitRateTrafficDataDemo () {
    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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。
      "ServiceIds": "s1,s2",
      // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。
      "DomainNames": "d1,d2",
      // 需要分组查询的参数。取值仅支持`DomainName`。
      "GroupBy": "DomainName",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。
      // note:
      // 由于仅支持查询近 93 天的历史数据,则若此刻时间为`2011-11-21T16:14:00+08:00`,那么您可输入最早的开始时间为`2011-08-21T00:00:00+08:00`。
      "StartTime": "2019-06-02T00:00:00+08:00",
      // 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。
      "EndTime": "2019-06-02T00:00:00+08:00",
      // 查询数据的时间粒度,单位为秒。缺省时查询`StartTime`和`EndTime`时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
      // <li> `60`:单次查询最大时间跨度为 6 小时 </li>
      // <li> `120`:单次查询最大时间跨度为 6 小时 </li>
      // <li> `300`:单次查询最大时间跨度为 31 天 </li>
      // <li> `600`:单次查询最大时间跨度为 31 天 </li>
      // <li> `1200`:单次查询最大时间跨度为 31 天 </li>
      // <li> `1800`:单次查询最大时间跨度为 31 天 </li>
      // <li> `3600`:单次查询最大时间跨度为 93 天 </li>
      // <li> `86400`:单次查询最大时间跨度为 93 天 </li>
      // <li> `604800`:单次查询最大时间跨度为 93 天 </li>
      "Interval": "300",
    }

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

查询请求命中率

您可以调用 DescribeImageXHitRateRequestData 接口查询请求命中率。详细的参数说明可参见 DescribeImageXHitRateRequestData 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function DescribeImageXHitRateRequestDataDemo () {
    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。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的[服务管理](https://console.volcengine.com/imagex/service_manage/)模块或者调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口获取服务 ID。
      "ServiceIds": "s1,s2",
      // 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取服务下所有域名信息。
      "DomainNames": "d1,d2",
      // 需要分组查询的参数。取值仅支持`DomainName`。
      "GroupBy": "DomainName",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。
      // note:
      // 由于仅支持查询近 93 天的历史数据,则若此刻时间为`2011-11-21T16:14:00+08:00`,那么您可输入最早的开始时间为`2011-08-21T00:00:00+08:00`。
      "StartTime": "2019-06-02T00:00:00+08:00",
      // 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。
      "EndTime": "2019-06-02T00:00:00+08:00",
      // 查询数据的时间粒度,单位为秒。缺省时查询`StartTime`和`EndTime`时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
      // <li> `60`:单次查询最大时间跨度为 6 小时 </li>
      // <li> `120`:单次查询最大时间跨度为 6 小时 </li>
      // <li> `300`:单次查询最大时间跨度为 31 天 </li>
      // <li> `600`:单次查询最大时间跨度为 31 天 </li>
      // <li> `1200`:单次查询最大时间跨度为 31 天 </li>
      // <li> `1800`:单次查询最大时间跨度为 31 天 </li>
      // <li> `3600`:单次查询最大时间跨度为 93 天 </li>
      // <li> `86400`:单次查询最大时间跨度为 93 天 </li>
      // <li> `604800`:单次查询最大时间跨度为 93 天 </li>
      "Interval": "300",
    }

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