客户状态监控--veImageX-火山引擎

文档中心

立即注册

导航

客户状态监控

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

阅读本文，您可以获取 Node SDK 客户状态监控的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍客户状态监控相关接口的功能和调用示例。

查询错误码时序数据

您可以调用 DescribeImageXClientErrorCodeByTime 接口查询错误码时序数据。详细的参数说明可参见 DescribeImageXClientErrorCodeByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientErrorCodeByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询错误码分布

您可以调用 DescribeImageXClientErrorCodeAll 接口查询错误码分布。详细的参数说明可参见 DescribeImageXClientErrorCodeAll 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientErrorCodeAllDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 聚合维度。取值如下所示：
      // * Domain：域名；
      // * ErrorCode：错误码；
      // * Region：地区；
      // * Isp：运营商。
      GroupBy: "Isp",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 目前仅支持传入Count按错误码数量排序。不传或者传空默认按错误码数量排序。
      OrderBy: "Count",
      // 是否升序排序。取值如下所示：
      // <li> true：是，表示升序排序。 </li>
      // <li> false：（默认）否，表示降序排序。 </li>
      OrderAsc: true,
    };

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

查询解码成功率

您可以调用 DescribeImageXClientDecodeSuccessRateByTime 接口查询解码成功率。详细的参数说明可参见 DescribeImageXClientDecodeSuccessRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientDecodeSuccessRateByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，不拆分。支持取值：
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </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。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询解码耗时

您可以调用 DescribeImageXClientDecodeDurationByTime 接口查询解码耗时。详细的参数说明可参见 DescribeImageXClientDecodeDurationByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientDecodeDurationByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，表示拆分分位数据。支持取值：
      // <li> Duration：表示拆分分位数据 </li>
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "Duration",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询排队耗时

您可以调用 DescribeImageXClientQueueDurationByTime 接口查询排队耗时。详细的参数说明可参见 DescribeImageXClientQueueDurationByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientQueueDurationByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，表示拆分分位数据。支持取值：
      // <li> Duration：表示拆分分位数据 </li>
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "Duration",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询加载耗时分布

您可以调用 DescribeImageXClientLoadDurationAll 接口查询加载耗时分布。详细的参数说明可参见 DescribeImageXClientLoadDurationAll 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientLoadDurationAllDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 聚合维度，取值如下所示：
      // <li> Domain：域名 </li>
      // <li> Region：地区 </li>
      // <li> Isp：运营商 </li>
      GroupBy: "Isp",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 排序依据，取值如下所示：
      // * Duration：按耗时排序。
      // * Count：（默认）按上报量排序。
      OrderBy: "Count",
      // 是否升序排序。取值如下所示：
      // <li> true：是，表示升序排序。 </li>
      // <li> false：（默认）否，表示降序排序。 </li>
      OrderAsc: true,
    };

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

查询加载耗时时序数据

您可以调用 DescribeImageXClientLoadDuration 接口查询加载耗时时序数据。详细的参数说明可参见 DescribeImageXClientLoadDuration 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientLoadDurationDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，表示拆分分位数据。支持取值：
      // <li> Duration：表示拆分分位数据 </li>
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "Duration",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询用户感知失败率

您可以调用 DescribeImageXClientFailureRate 接口查询用户感知失败率。详细的参数说明可参见 DescribeImageXClientFailureRate 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientFailureRateDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，不拆分。支持取值：
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </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。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询 SDK 版本变化趋势

您可以调用 DescribeImageXClientSdkVerByTime 接口查询 SDK 版本变化趋势。详细的参数说明可参见 DescribeImageXClientSdkVerByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientSdkVerByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询文件大小分布

您可以调用 DescribeImageXClientFileSize 接口查询文件大小分布。详细的参数说明可参见 DescribeImageXClientFileSize 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientFileSizeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，表示拆分分位数据。支持取值：
      // <li> Duration：表示拆分分位数据 </li>
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </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。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询文件大小 TOP URL

您可以调用 DescribeImageXClientTopFileSize 接口查询文件大小 TOP URL。详细的参数说明可参见 DescribeImageXClientTopFileSize 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientTopFileSizeDemo() {
  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。默认为空，不传则匹配账号下的所有的 App ID。您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "iOS",
      // 获取数据起始时间点。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2020-11-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2020-11-30T15:00:00+08:00",
      // 查询 Top URL 条数，取值范围为[0,1000]，默认值为 1000。
      Top: 1000,
    };

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

查询客户端上报量

您可以调用 DescribeImageXClientCountByTime 接口查询客户端上报量。详细的参数说明可参见 DescribeImageXClientCountByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientCountByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，不拆分。支持取值：
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </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。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询画质评估时序数据

您可以调用 DescribeImageXClientScoreByTime 接口查询画质评估时序数据。详细的参数说明可参见 DescribeImageXClientScoreByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientScoreByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，不拆分。支持取值：
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标。 </li>
      GroupBy: "OS",
      // 打分类型。取值如下所示：
      // <li> vq：查询 vqscore 指标 </li>
      // <li> aes：查询美学指标 </li>
      // <li> noi：查询噪声指标 </li>
      // <li> psnr：查询 psnr 指标 </li>
      // <li> ssim：查询 ssim 指标 </li>
      // <li> vmaf：查询 vmaf 指标 </li>
      ScoreType: "vq",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询降级率时序数据

您可以调用 DescribeImageXClientDemotionRateByTime 接口查询降级率时序数据。详细的参数说明可参见 DescribeImageXClientDemotionRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientDemotionRateByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，表示拆分分位数据。支持取值：
      // <li> Duration：表示拆分分位数据 </li>
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "Duration",
      // 降级类型。取值如下所示：
      // <li> heic：查询 heic 降级率 </li>
      // <li> heif：查询 heif 降级率 </li>
      // <li> avif：查询 avif 降级率 </li>
      DemotionType: "heic",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询降级率 TOP URL

您可以调用 DescribeImageXClientTopDemotionURL 接口查询降级率 TOP URL。详细的参数说明可参见 DescribeImageXClientTopDemotionURL 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientTopDemotionURLDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "iOS",
      // 降级类型。取值如下所示：
      // <li> heic：HEIC 降级 </li>
      // <li> heif：HEIF 降级 </li>
      // <li> avif：AVIF 降级 </li>
      DemotionType: "heic",
      // 获取数据起始时间点。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2023-01-01T00:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2023-01-01T00:00:00+08:00",
      // 查询 Top URL 条数，取值范围为[0,1000]，默认值为 1000。
      Top: 1000,
    };

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

查询黑白屏率时序数据

您可以调用 DescribeImageXClientQualityRateByTime 接口查询黑白屏率时序数据。详细的参数说明可参见 DescribeImageXClientQualityRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientQualityRateByTimeDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。
      // note：
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.2.0"],
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本.
      SdkVer: ["1.2.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的域名，不传则匹配所有域名。
      Domain: ["d1"],
      // 需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示：
      // <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: "access",
          // 需要匹配的对应维度值
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 拆分维度。默认为空，不拆分。支持取值：
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "OS",
      // 质量类型。取值如下所示：
      // <li> white_suspected：查询白屏率 </li>
      // <li> black_suspected：查询黑屏率 </li>
      // <li> transparent_suspected：查询透明图率 </li>
      QualityType: "transparent_suspected",
      // 获取数据起始时间点。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      StartTime: "2019-06-27T13:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。
      // 日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      EndTime: "2019-06-27T15:00:00+08:00",
      // 返回数据的时间粒度。取值如下所示：
      // * 5m：5 分钟；
      // * 1h：1 小时；
      // * 1d：1 天。
      Granularity: "1h",
    };

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

查询黑白屏 TOP URL

您可以调用 DescribeImageXClientTopQualityURL 接口查询黑白屏 TOP URL。详细的参数说明可参见 DescribeImageXClientTopQualityURL 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXClientTopQualityURLDemo() {
  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。默认为空，不传则匹配账号下的所有的 AppID。您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "iOS",
      // 类型。取值如下所示：
      // <li> transparent_suspected：透明图 </li>
      // <li> white_suspected：白屏 </li>
      // <li> black_suspected：黑屏 </li>
      QualityType: "black_suspected",
      // 获取数据起始时间点。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // 起始时间与结束时间间隔小于等于 93 天。
      StartTime: "2023-01-01T00:00:00+08:00",
      // 获取数据结束时间点，需在起始时间点之后。日期格式按照ISO8601表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如2019-06-02T00:00:00+08:00。
      // 起始时间与结束时间间隔小于等于 93 天。
      EndTime: "2023-01-01T00:00:00+08:00",
      // 查询 Top URL 条数，取值范围为 [0,1000]，默认值为 1000。
      Top: 1000,
    };

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