用量统计--veImageX-火山引擎

文档中心

立即注册

导航

用量统计

最近更新时间：2024.08.12 15:33:25首次发布时间：2024.06.03 19:01:59

阅读本文，您可以获取 Node SDK 用量统计的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍用量统计相关接口的功能和调用示例。

查询用量概览

您可以调用 DescribeImageXSummary 接口查询用量概览。详细的参数说明可参见 DescribeImageXSummary 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXSummaryDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 数据查询时间段，即Timestamp所在月份的 1 日 0 时起至传入时间Timestamp的时间范围。
      // 格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      Timestamp: "2019-06-02T00:00:00+08:00",
    };

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

获取流量用量

您可以调用 DescribeImageXDomainTrafficData 接口获取流量用量。详细的参数说明可参见 DescribeImageXDomainTrafficData 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXDomainTrafficDataDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 计费区域。支持查询多个区域，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有区域。取值如下所示：
      // <li> CHN：中国内地 </li>
      // <li> AP1：亚太一区 </li>
      // <li> AP2：亚太二区 </li>
      // <li> AP3：亚太三区 </li>
      // <li> EU：欧洲 </li>
      // <li> ME：中东和非洲 </li>
      // <li> SA：南美 </li>
      // <li> NA：北美 </li>
      // <li> OTHER：其他 </li>
      BillingRegion: "CHN,AP1",
      // 需要分组查询的参数。不传表示不拆分维度，传入多个用英文逗号分隔。取值如下所示：
      // <li> ServiceId：服务 ID </li>
      // <li> DomainName ：域名 </li>
      GroupBy: "DomainName",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXDomainTrafficData(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询带宽用量

您可以调用 DescribeImageXDomainBandwidthData 接口查询带宽用量。详细的参数说明可参见 DescribeImageXDomainBandwidthData 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXDomainBandwidthDataDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 计费区域。支持查询多个区域，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有区域。取值如下所示：
      // <li> CHN：中国内地 </li>
      // <li> AP1：亚太一区 </li>
      // <li> AP2：亚太二区 </li>
      // <li> AP3：亚太三区 </li>
      // <li> EU：欧洲 </li>
      // <li> ME：中东和非洲 </li>
      // <li> SA：南美 </li>
      // <li> NA：北美 </li>
      // <li> OTHER：其他 </li>
      BillingRegion: "CHN,AP1",
      // 需要分组查询的参数。不传表示不拆分维度，传入多个用英文逗号分隔。取值如下所示：
      // <li> ServiceId：服务 ID </li>
      // <li> DomainName ：域名 </li>
      GroupBy: "DomainName",
      // 取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXDomainBandwidthData(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询 95 带宽用量

您可以调用 DescribeImageXDomainBandwidthNinetyFiveData 接口查询 95 带宽用量。详细的参数说明可参见 DescribeImageXDomainBandwidthNinetyFiveData 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXDomainBandwidthNinetyFiveDataDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 计费区域。支持查询多个区域，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有区域。取值如下所示：
      // <li> CHN：中国内地 </li>
      // <li> AP1：亚太一区 </li>
      // <li> AP2：亚太二区 </li>
      // <li> AP3：亚太三区 </li>
      // <li> EU：欧洲 </li>
      // <li> ME：中东和非洲 </li>
      // <li> SA：南美 </li>
      // <li> NA：北美 </li>
      // <li> OTHER：其他 </li>
      BillingRegion: "CHN,AP1",
      // 取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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",
    };

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

查询请求次数

您可以调用 DescribeImageXRequestCntUsage 接口查询请求次数。详细的参数说明可参见 DescribeImageXRequestCntUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXRequestCntUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 组件名称。支持查询多个组件，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有组件。您可通过调用 [GetImageAddOnConf](https://www.volcengine.com/docs/508/66145) 查看Key返回值。
      AdvFeats: "a1,a2",
      // 图片处理模板。支持查询多个模板，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有模板。您可通过调用 [GetAllImageTemplates](https://www.volcengine.com/docs/508/9386) 获取服务下全部模版信息。
      Templates: "t1,t2",
      // 维度拆分的维度值。不传表示不拆分维度，只能传入单个参数。支持取值如下：
      // <li> ServiceId：服务 </li>
      // <li> AdvFeat：组件 </li>
      GroupBy: "AdvFeat",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXRequestCntUsage(requestParam);
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询基础处理量

您可以调用 DescribeImageXBaseOpUsage 接口查询基础处理量。详细的参数说明可参见 DescribeImageXBaseOpUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXBaseOpUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 需要分组查询的参数，当前仅支持取值 ServiceId，表示按服务 ID 进行分组。
      GroupBy: "ServiceId",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXBaseOpUsage(requestParam);
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询高效压缩量

您可以调用 DescribeImageXCompressUsage 接口查询高效压缩量。详细的参数说明可参见 DescribeImageXCompressUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXCompressUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 需要分组查询的参数，当前仅支持取值 ServiceId，表示按服务 ID 进行分组。
      GroupBy: "ServiceId",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXCompressUsage(requestParam);
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询截帧用量

您可以调用 DescribeImageXScreenshotUsage 接口查询截帧用量。详细的参数说明可参见 DescribeImageXScreenshotUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXScreenshotUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXScreenshotUsage(requestParam);
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询小视频转动图用量

您可以调用 DescribeImageXVideoClipDurationUsage 接口查询小视频转动图用量。详细的参数说明可参见 DescribeImageXVideoClipDurationUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXVideoClipDurationUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXVideoClipDurationUsage(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询多文件压缩用量

您可以调用 DescribeImageXMultiCompressUsage 接口查询多文件压缩用量。详细的参数说明可参见 DescribeImageXMultiCompressUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXMultiCompressUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 获取数据起始时间点。日期格式按照 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> 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.DescribeImageXMultiCompressUsage(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询资源占用量

您可以调用 DescribeImageXBucketRetrievalUsage 接口查询资源占用量。详细的参数说明可参见 DescribeImageXBucketRetrievalUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXBucketRetrievalUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      secretKey: process.env.VOLC_SECRETKEY,
    });

    const requestParam = {
      // 服务 ID。为空时表示不筛选，支持查询多个服务，使用逗号分隔不同的服务。
      // <li> 您可以在 veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考 [GetAllImageServices](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceIds: "s1,s2",
      // Bucket 名称。支持同时查询多个 BucketName，不同的 BucketNmae 使用逗号分隔。
      // 您可以通过调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 获取所需的 Bucket 名称。
      BucketNames: "b1,b2",
      // 需要分组查询的参数，多个数据用逗号分隔。支持取值如下：
      // <li> ServiceId：服务 ID </li>
      // <li> BucketName：Bucket 名称 </li>
      // <li> StorageType：存储类型 </li>
      GroupBy: "ServiceId,BucketName,StorageType",
      // 获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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",
    };

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

获取附加组件通用请求次数

您可以调用 DescribeImageXBillingRequestCntUsage 接口获取附加组件通用请求次数。详细的参数说明可参见 DescribeImageXBillingRequestCntUsage 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";

export async function DescribeImageXBillingRequestCntUsageDemo() {
  try {
    const imagexService = new imagex.ImagexService({
      // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
      accessKeyId: process.env.VOLC_ACCESSKEY,
      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",
      // 组件名称。支持查询多个组件，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有组件。您可通过调用 [GetImageAddOnConf](https://www.volcengine.com/docs/508/66145) 查看Key返回值。
      AdvFeats: "a1,a2",
      // 固定值，仅支持AdvFeat即附加组件。
      GroupBy: "AdvFeat",
      // 获取数据起始时间点。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // note：
      // 由于仅支持查询近一年历史数据，则若此刻时间为2011-11-21T16:14:00+08:00，那么您可输入最早的开始时间为2010-11-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> 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.DescribeImageXBillingRequestCntUsage(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}