阅读本文，您可以获取 Node SDK 上传数据监控的接口调用示例，实现快速开发。

调用说明

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

前提条件

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

调用示例

本节为您介绍上传数据监控相关接口的功能和调用示例。

查询上传成功率

您可以调用 DescribeImageXUploadSuccessRateByTime 接口查询上传成功率。详细的参数说明可参见 DescribeImageXUploadSuccessRateByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXUploadSuccessRateByTimeDemo() {
  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"],
      // 需要匹配的系统类型。取值如下所示：
      // <li> 不传或传空字符串：Android+iOS。 </li>
      // <li> iOS：iOS。 </li>
      // <li> Android：Android。 </li>
      // <li> WEB：web+小程序。 </li>
      // <li> Web：web。 </li>
      // <li> Imp：小程序。 </li>
      OS: "iOS",
      // 需要匹配的 SDK 版本，不传则匹配所有版本。
      SdkVer: ["1.1.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的自定义维度项。
      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、Country、Province、Isp </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "OS",
      // 上传类型，默认为空，返回上传 1.0 数据。取值如下所示：
      // * 1：上传 1.0。
      // * 2：上传 2.0。
      UploadType: 2,
      // 获取数据起始时间点。
      // 日期格式按照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.DescribeImageXUploadSuccessRateByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询错误码时序数据

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

接口调用示例如下所示。

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

export async function DescribeImageXUploadErrorCodeByTimeDemo() {
  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"],
      // 需要匹配的系统类型。取值如下所示：
      // <li> 不传或传空字符串：Android+iOS。 </li>
      // <li> iOS：iOS。 </li>
      // <li> Android：Android。 </li>
      // <li> WEB：web+小程序。 </li>
      // <li> Web：web。 </li>
      // <li> Imp：小程序。 </li>
      OS: "iOS",
      // 需要匹配的 SDK 版本，不传则匹配所有版本。
      SdkVer: ["1.1.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的自定义维度项。
      ExtraDims: [
        {
          // 自定义维度名称。
          // note：
          // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。
          Dim: "access",
          // 需要匹配的对应维度值。
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 上传类型，默认为空，返回上传 1.0 数据。取值如下所示：
      // * 1：上传 1.0。
      // * 2：上传 2.0。
      UploadType: 2,
      // 获取数据起始时间点。
      // 日期格式按照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.DescribeImageXUploadErrorCodeByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询错误码分布

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

接口调用示例如下所示。

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

export async function DescribeImageXUploadErrorCodeAllDemo() {
  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"],
      // 需要匹配的系统类型。取值如下所示：
      // <li> 不传或传空字符串：Android+iOS。 </li>
      // <li> iOS：iOS。 </li>
      // <li> Android：Android。 </li>
      // <li> WEB：web+小程序。 </li>
      // <li> Web：web。 </li>
      // <li> Imp：小程序。 </li>
      OS: "iOS",
      // 需要匹配的 SDK 版本，不传则匹配所有版本。
      SdkVer: ["1.1.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的自定义维度项。
      ExtraDims: [
        {
          // 自定义维度名称。
          // note：
          // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)来获取。
          Dim: "access",
          // 需要匹配的对应维度值。
          // note：
          // 您可以通过调用[获取自定义维度值](https://www.volcengine.com/docs/508/1213050)来获取。
          Vals: ["4g"],
        },
      ],
      // 聚合维度。取值如下所示：
      // * ErrorCode：错误码
      // * Region：地区
      // * Isp：运营商
      GroupBy: "Isp",
      // 上传类型，默认为空，返回上传 1.0 数据。取值如下所示：
      // * 1：上传 1.0。
      // * 2：上传 2.0。
      UploadType: 2,
      // 获取数据起始时间点。
      // 日期格式按照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.DescribeImageXUploadErrorCodeAll(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询上传有效次数

您可以调用 DescribeImageXUploadCountByTime 接口查询上传有效次数。详细的参数说明可参见 DescribeImageXUploadCountByTime 接口文档。

接口调用示例如下所示。

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

export async function DescribeImageXUploadCountByTimeDemo() {
  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/19511)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的 App 版本，不传则匹配 App 的所有版本。
      AppVer: ["1.0"],
      // 需要匹配的系统类型。取值如下所示：
      // <li> 不传或传空字符串：Android+iOS。 </li>
      // <li> iOS：iOS。 </li>
      // <li> Android：Android。 </li>
      // <li> WEB：web+小程序。 </li>
      // <li> Web：web。 </li>
      // <li> Imp：小程序。 </li>
      OS: "iOS",
      // 需要匹配的 SDK 版本，不传则匹配所有版本。
      SdkVer: ["1.1.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的自定义维度项。
      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、Country、Province、Isp </li>
      // <li> 自定义维度：您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "OS",
      // 上传类型，默认为空，返回上传 1.0 数据。取值如下所示：
      // * 1：上传 1.0。
      // * 2：上传 2.0。
      UploadType: 2,
      // 获取数据起始时间点。
      // 日期格式按照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.DescribeImageXUploadCountByTime(
      requestParam
    );
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}

查询上传文件大小分布

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

接口调用示例如下所示。

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

export async function DescribeImageXUploadFileSizeDemo() {
  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"],
      // 需要匹配的系统类型。取值如下所示：
      // <li> 不传或传空字符串：Android+iOS。 </li>
      // <li> iOS：iOS。 </li>
      // <li> Android：Android。 </li>
      // <li> WEB：web+小程序。 </li>
      // <li> Web：web。 </li>
      // <li> Imp：小程序。 </li>
      OS: "iOS",
      // 需要匹配的 SDK 版本，不传则匹配所有版本。
      SdkVer: ["1.1.0"],
      // 需要匹配的国家名称。
      // * 不传则匹配所有国家。
      // * 取值为海外时，匹配海外所有国家。
      Country: "海外",
      // 需要匹配的省份名称，不传则匹配所有省份。
      Province: "北京",
      // 需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示：
      // <li> 电信 </li>
      // <li> 联通 </li>
      // <li> 移动 </li>
      // <li> 铁通 </li>
      // <li> 鹏博士 </li>
      // <li> 教育网 </li>
      // <li> 其他 </li>
      Isp: ["电信"],
      // 需要匹配的自定义维度项。
      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、Country、Province、Isp </li>
      // <li> 自定义维度：您可以通过调用 [获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)接口获取自定义维度指标 </li>
      GroupBy: "OS",
      // 上传类型，默认为空，返回上传 1.0 数据。取值如下所示：
      // * 1：上传 1.0。
      // * 2：上传 2.0。
      UploadType: 2,
      // 获取数据起始时间点。
      // 日期格式按照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.DescribeImageXUploadFileSize(requestParam);
    console.log("res", res);
  } catch (err) {
    console.error(err);
  }
}