You need to enable JavaScript to run this app.
导航
获取下拉选项
最近更新时间:2024.08.12 15:33:25首次发布时间:2024.06.03 19:01:59

阅读本文,您可以获取 Node SDK 获取下拉选项的接口调用示例,实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍获取下拉选项相关接口的功能和调用示例。

查询应用列表

您可以调用 GetImageXQueryApps 接口查询应用列表。详细的参数说明可参见 GetImageXQueryApps 接口文档。

接口调用示例如下所示。

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

export async function GetImageXQueryAppsDemo() {
  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 = {
      // 数据来源,账号下近 60 天内有数据上报的应用 ID,缺省情况下返回账号对应的全部应用 ID。取值如下所示:
      // * upload:上传 1.0 数据。
      // * cdn:下行网络数据。
      // * client:客户端数据。
      // * sensible:感知数据。
      // * uploadv2:上传 2.0 数据。
      // * exceed:大图监控数据。
      Source: "upload",
    };

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

查询地区列表

您可以调用 GetImageXQueryRegions 接口查询地区列表。详细的参数说明可参见 GetImageXQueryRegions 接口文档。

接口调用示例如下所示。

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

export async function GetImageXQueryRegionsDemo() {
  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 = {
      // 数据来源,取值如下所示:
      // * upload:上传 1.0 数据。
      // * cdn:下行网络数据。
      // * client:客户端数据。
      // * uploadv2:上传 2.0 数据。
      Source: "client",
      // 应用 ID。默认为空,匹配账号下所有的 AppID。
      // note:
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的应用 ID。
      Appid: "13",
      // 需要匹配的系统类型。取值如下所示:
      // <li> 不传或传空字符串:Android+iOS。 </li>
      // <li> iOS:iOS。 </li>
      // <li> Android:Android。 </li>
      // <li> WEB:web+小程序。 </li>
      // <li> Web:web,仅当Source为upload或uploadv2时可传。 </li>
      // <li> Imp:小程序,仅当Source为upload或uploadv2时可传。 </li>
      OS: "Android",
    };

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

查询自定义维度列表

您可以调用 GetImageXQueryDims 接口查询自定义维度列表。详细的参数说明可参见 GetImageXQueryDims 接口文档。

接口调用示例如下所示。

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

export async function GetImageXQueryDimsDemo() {
  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 = {
      // 数据来源,取值如下所示:
      // * upload:上传 1.0 数据。
      // * cdn:下行网络数据。
      // * client:客户端数据。
      // * sensible:感知数据。
      // * uploadv2:上传 2.0 数据。
      // * exceed:大图监控数据,包含大图样本量和大图明细。
      // * exceed_all:大图分布数据。
      Source: "upload",
      // 应用 ID。默认为空,匹配账号下所有的 AppID。
      // note:
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的系统类型。取值如下所示:
      // <li> 不传或传空字符串:Android+iOS。 </li>
      // <li> iOS:iOS。 </li>
      // <li> Android:Android。 </li>
      // <li> WEB:web+小程序。 </li>
      // <li> Web:web,仅当Source为upload或uploadv2时可传。 </li>
      // <li> Imp:小程序,仅当Source为upload或uploadv2时可传。 </li>
      OS: "iOS",
    };

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

查询自定义维度值

您可以调用 GetImageXQueryVals 接口查询自定义维度值。详细的参数说明可参见 GetImageXQueryVals 接口文档。

接口调用示例如下所示。

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

export async function GetImageXQueryValsDemo() {
  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 = {
      // 自定义维度名称。
      // note:
      // 您可以通过调用[获取自定义维度列表](https://www.volcengine.com/docs/508/1213048)获取所需的维度名称。
      Dim: "biz_tag",
      // 数据来源。
      // * upload:上传 1.0 数据。
      // * cdn:下行网络数据。
      // * client:客户端数据。
      // * sensible:感知数据。
      // * uploadv2:上传 2.0 数据。
      // * exceed:大图监控数据,包含大图样本量和大图明细。
      // * exceed_all:大图分布数据。
      Source: "upload",
      // 应用 ID。默认为空,匹配中账号下所有的 AppID。
      // note:
      // 您可以通过调用[获取应用列表](https://www.volcengine.com/docs/508/1213042)的方式获取所需的 AppID。
      Appid: "123",
      // 需要匹配的系统类型。取值如下所示:
      // <li> 不传或传空字符串:Android+iOS。 </li>
      // <li> iOS:iOS。 </li>
      // <li> Android:Android。 </li>
      // <li> WEB:web+小程序。 </li>
      // <li> Web:web,仅当Source为upload或uploadv2时可传。 </li>
      // <li> Imp:小程序,仅当Source为upload或uploadv2时可传。 </li>
      OS: "iOS",
      // 需要过滤的关键词(包含),不传则不过滤关键词。
      Keyword: "transcode",
    };

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