You need to enable JavaScript to run this app.
导航
刷新/预热/禁用/解禁
最近更新时间:2024.06.04 11:54:44首次发布时间:2024.06.04 11:54:44

阅读本文,您可以获取 Node SDK 刷新/预热/禁用/解禁的接口调用示例,实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍刷新/预热/禁用/解禁相关接口的功能和调用示例。

创建刷新/预热/禁用/解禁任务

您可以调用 CreateImageContentTask 接口创建刷新/预热/禁用/解禁任务。详细的参数说明可参见 CreateImageContentTask 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function CreateImageContentTaskDemo () {
    try {
      const imagexService = new imagex.ImagexService({
        // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        accessKeyId: process.env.VOLC_ACCESSKEY,
        // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        secretKey: process.env.VOLC_SECRETKEY,
      });
      const requestParam = {
      // 服务 ID。您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面,在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。
      "ServiceId": "8h**9q",
      // 操作类型。取值如下所示:
      // <li> `refresh_url`:刷新 URL </li>
      // <li> `refresh_dir`:目录刷新(支持根目录刷新) </li>
      // <li> `preload_url`:预热 URL </li>
      // <li> `block_url`:禁用 URL </li>
      // <li> `unblock_url`:解禁 URL </li>
      "TaskType": "refresh_url",
      // 资源 URL 或者目录。
      // <li> 当`TaskType`取值`refresh_url`,一次可提交的最大限额为 2000 个; </li>
      // <li> 当`TaskType`取值`refresh_dir`,一次可提交的最大限额为 50 个; </li>
      // <li> 当`TaskType`取值`preload_url`,一次可提交的最大限额为 2000 个; </li>
      // <li> 当`TaskType`取值`block_url`,一次可提交的最大限额为 2000 个; </li>
      // <li> 当`TaskType`取值`unblock_url`,一次可提交的最大限额为 2000 个。 </li>
      "Urls" : ["url1","url2"], 
    }

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

获取任务详情

您可以调用 GetImageContentTaskDetail 接口获取任务详情。详细的参数说明可参见 GetImageContentTaskDetail 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function GetImageContentTaskDetailDemo () {
    try {
      const imagexService = new imagex.ImagexService({
        // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        accessKeyId: process.env.VOLC_ACCESSKEY,
        // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        secretKey: process.env.VOLC_SECRETKEY,
      });
      const requestParam = {
      // 内容管理任务类型,取值如下所示:
      // * `refresh`:刷新任务,包含刷新 URL 和刷新目录。
      // * `refresh_url`:刷新 URL
      // * `block_url`:禁用 URL
      // * `unblock_url`:解禁 URL
      // * `preload_url`:预热 URL
      // * `refresh_dir`:目录刷新(支持根目录刷新)
      "TaskType": "refresh_url",
      // 待查询任务 ID
      "TaskId": "123***89",
    }

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

获取禁用 URL 列表详情

您可以调用 GetImageContentBlockList 接口获取禁用 URL 列表详情。详细的参数说明可参见 GetImageContentBlockList 接口文档。

接口调用示例如下所示。

import { imagex } from "@volcengine/openapi";
  
  export async function GetImageContentBlockListDemo () {
    try {
      const imagexService = new imagex.ImagexService({
        // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        accessKeyId: process.env.VOLC_ACCESSKEY,
        // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        secretKey: process.env.VOLC_SECRETKEY,
      });
      const requestParam = {
      // 服务 ID。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面,在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      "ServiceId": "8h**9q",
    }

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