下行网络监控--veImageX-火山引擎

文档中心

立即注册

导航

下行网络监控

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

阅读本文，您可以获取 Node SDK 下行网络监控的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍下行网络监控相关接口的功能和调用示例。

查询网络成功率时序数据

您可以调用 DescribeImageXCdnSuccessRateByTime 接口查询网络成功率时序数据。详细的参数说明可参见 DescribeImageXCdnSuccessRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXCdnSuccessRateByTimeDemo() {
  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.DescribeImageXCdnSuccessRateByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询网络成功率分布

您可以调用 DescribeImageXCdnSuccessRateAll 接口查询网络成功率分布。详细的参数说明可参见 DescribeImageXCdnSuccessRateAll 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXCdnSuccessRateAllDemo() {
  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.0.1"],
      // 需要匹配的系统类型，不传则匹配所有非 WEB 端的系统。取值如下所示：
      // <li> iOS </li>
      // <li> Android </li>
      // <li> WEB </li>
      OS: "WEB",
      // 需要匹配的 SDK 版本，不传则匹配所有版本。
      SdkVer: ["1.34.1"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      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：域名；
      // * 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",
      // * 取值为SuccessRate时，表示按网络成功率排序；
      // * 取值为Count时，表示按上报量排序；
      // * 不传或者传空默认按上报量排序。
      OrderBy: "Count",
      // 是否升序排序。取值如下所示：
      // <li> true：是，表示升序排序。 </li>
      // <li> false：（默认）否，表示降序排序。 </li>
      OrderAsc: true,
    };

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

查询错误码时序数据

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

接口调用示例如下所示。

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

export async function DescribeImageXCdnErrorCodeByTimeDemo() {
  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.DescribeImageXCdnErrorCodeByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询错误码分布

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

接口调用示例如下所示。

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

export async function DescribeImageXCdnErrorCodeAllDemo() {
  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.DescribeImageXCdnErrorCodeAll(requestParam);
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询网络耗时时序数据

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

接口调用示例如下所示。

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

export async function DescribeImageXCdnDurationDetailByTimeDemo() {
  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。
      // 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"],
        },
      ],
      // 拆分维度。默认为空，标识不拆分。支持取值：
      // * Duration：表示拆分网络耗时分位数据
      // <li> Phase：表示拆分网络耗时分布数据 </li>
      // <li> 公共维度：Appid、OS、AppVer、SdkVer、ImageType、Country、Province、Isp、Domain </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标。 </li>
      GroupBy: "Duration",
      // 指定查询特定阶段的耗时数据。默认空，返回总耗时数据。
      // * dns： DNS 耗时，即网络阶段的 DNS 平均耗时。
      // * ssl： SSL 耗时，即网络阶段的 SSL 握手平均耗时。
      // * connect：连接耗时，即网络阶段的 TCP 建立连接平均耗时。
      // * send：发送耗时，即网络阶段的发送数据平均耗时。
      // * wait：等待耗时，即网络阶段发送完数据后等待首个回包字节的耗时。
      // * receive：接收耗时，即网络阶段的接收数据耗时。
      // * proxy：代理耗时，即网络阶段的建立代理连接的耗时。
      Phase: "send",
      // 获取数据起始时间点。
      // * 日期格式按照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.DescribeImageXCdnDurationDetailByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询网络耗时分布

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

接口调用示例如下所示。

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

export async function DescribeImageXCdnDurationAllDemo() {
  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：域名；
      // * 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",
      // 排序依据。取值如下所示：
      // * Duration：按耗时排序。
      // * Count：（默认）按上报量排序。
      OrderBy: "Count",
      // 是否升序排序。取值如下所示：
      // <li> true：是，表示升序排序。 </li>
      // <li> false：（默认）否，表示降序排序。 </li>
      OrderAsc: true,
    };

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

查询网络连接复用率时序数据

您可以调用 DescribeImageXCdnReuseRateByTime 接口查询网络连接复用率时序数据。详细的参数说明可参见 DescribeImageXCdnReuseRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXCdnReuseRateByTimeDemo() {
  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.DescribeImageXCdnReuseRateByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询网络连接复用率分布

您可以调用 DescribeImageXCdnReuseRateAll 接口查询网络连接复用率分布。详细的参数说明可参见 DescribeImageXCdnReuseRateAll 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXCdnReuseRateAllDemo() {
  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",
      // 维度区分，不传或者传空默认按上报量排序。取值如下所示：
      // * ReuseRate：按连接复用率排序；
      // * Count：按上报量排序。
      OrderBy: "Count",
      // 是否升序排序。取值如下所示：
      // <li> true：是，表示升序排序。 </li>
      // <li> false：（默认）否，表示降序排序。 </li>
      OrderAsc: true,
    };

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

查询网络协议占比

您可以调用 DescribeImageXCdnProtocolRateByTime 接口查询网络协议占比。详细的参数说明可参见 DescribeImageXCdnProtocolRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXCdnProtocolRateByTimeDemo() {
  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.DescribeImageXCdnProtocolRateByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}