域名管理--veImageX-火山引擎

文档中心

veImageX

Node.js SDK

域名管理

阅读本文，您可以获取 Node.js SDK 域名管理的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍域名管理相关接口的功能和调用示例。

新增域名

您可以调用 AddDomainV1 接口新增域名。详细的参数说明可参见 AddDomainV1 接口文档。

接口调用示例如下所示。

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

export async function AddDomainV1Demo() {
  try {
    const Client = 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。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "qhc**nuslz",
      // 新增域名。
      domain: "test456.volcimagextest.com",
      // 证书配置，海外加速或者全球加速为必选，否则审核不通过。
      https: [
        {
          // 是否开启 Https，取值如下所示：
          // <li> true：开启 </li>
          // <li> false：关闭 </li>
          enable_https: true,
          // 是否强制使用 Https，取值如下所示：
          // <li> true：强制 </li>
          // <li> false：不强制 </li>
          force_https: false,
          // 证书 ID，若enable_https为true，则为必选。
          cert_id: "cert-bce71503813******84072a423610471",
        },
      ],
      // 访问控制配置。
      access_control: [
        {
          // Referer 配置。
          refer_link: [
            {
              // 是否开启 Referer 防盗链，取值如下所示：
              // * true：开启
              // * false：关闭
              enabled: true,
              // 是否配置白名单，取值如下所示：
              // <li> true：配置白名单 </li>
              // <li> false：配置黑名单 </li>
              is_white_mode: true,
              // 根据是否为白名单，为对应的白/黑名单的值。
              values: ["s.com", "y.com", "q.com"],
              // 是否允许空 Referer，取值如下所示：
              // <li> true：允许空 Referer </li>
              // <li> false：不允许空 Referer </li>
              allow_empty_refer: false,
            },
          ],
        },
      ],
      // 请求需要添加的响应头。
      resp_hdrs: [
        {
          // Header Key，请见[支持配置的响应头](https://www.volcengine.com/docs/508/196704#%E6%94%AF%E6%8C%81%E9%85%8D%E7%BD%AE%E7%9A%84%E5%93%8D%E5%BA%94%E5%A4%B4)。
          key: "Access-Control-Allow-Origin",
          // Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除美元符号（$），Delete（ASCII code 127）外的可打印 ASCII 字符。
          value: "*",
        },
      ],
    };

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

删除域名

您可以调用 DelDomain 接口删除域名。详细的参数说明可参见 DelDomain 接口文档。

接口调用示例如下所示。

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

export async function DelDomainDemo() {
  try {
    const Client = 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。
      // <li> 您可以在 veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "sedf**sdf",
      // 待删除的域名，您可以通过 [获取服务下全部域名](https://www.volcengine.com/docs/508/9379) 获取服务下域名信息。
      Domain: "test.imagex.com",
    };

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

更新域名配置

您可以调用 UpdateImageDomainConfig 接口更新域名配置。详细的参数说明可参见 UpdateImageDomainConfig 接口文档。

接口调用示例如下所示。

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

export async function UpdateImageDomainConfigDemo() {
  try {
    const Client = 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。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "uh****7d",
      // 域名列表，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domains: ["a.imagex.cn"],
      // HTTPS 配置
      https: {
        // 是否开启 http2，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_http2: true,
        // 是否开启 https，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_https: true,
        // 支持的 tls 版本。取值如下所示：
        // <li> tlsv1.0 </li>
        // <li> tlsv1.1 </li>
        // <li> tlsv1.2 </li>
        // <li> tlsv1.3 </li>
        tls_versions: ["tlsv1.1"],
        // 需要关联的证书 ID，若enable_https为true，则为必填。
        cert_id: "iuhs2928jdh",
        // 是否开启强制跳转，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_force_redirect: true,
        // 仅当enable_force_redirect取值为true时需要配置，强制跳转类型。
        // 取值如下所示：
        // <li> http2https：HTTP 到 HTTPS </li>
        // <li> https2http：HTTPS 到 HTTP </li>
        force_redirect_type: "http2https",
        // 仅当enable_force_redirect取值为true时需要配置，强制跳转状态码。
        // 取值如下所示：
        // <li> 301：返回给用户 301 状态码进行重定向。 </li>
        // <li> 302：返回给用户 302 状态码进行重定向。 </li>
        force_redirect_code: "301",
        // HSTS 配置
        hsts: {
          // 是否开启 HSTS 配置，取值如下所示：
          // <li> true：是 </li>
          // <li> false：否 </li>
          enabled: true,
          // HSTS 配置是否也应用于加速域名的子域名。取值如下所示：
          // <li> include：应用于子域名站点。  </li>
          // <li> exclude：（默认）不应用于子域名站点。 </li>
          subdomain: "exclude",
          // 如果 enable_https 是 true，该参数为必填。
          // Strict-Transport-Security 响应头在浏览器中的缓存过期时间，单位是秒。取值范围是 [0,31,536,000]。31,536,000 秒表示 365 天。如果该参数值指定为 0，其效果等同于禁用 HSTS 设置。
          ttl: 23400,
        },
      },
      // Referer 防盗链配置
      referer_link: {
        // 是否开启 Referer 防盗链，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enabled: true,
        // 是否选择白名单，取值如下所示：
        // <li> true：配置白名单 </li>
        // <li> false：配置黑名单 </li>
        is_white_mode: true,
        // 黑白名单 Referer 规则，可输入域名或 IP 地址，最大限制为 1000 条。
        values: ["s.com", "y.com", "q.com"],
        // 正则表达式规则列表，最大限制为 100 条。
        regex_values: ["192.23.1.8\b"],
        // 是否允许空 Referer，取值如下所示：
        // <li> true：允许空 Referer </li>
        // <li> false：不允许空 Referer </li>
        allow_empty_refer: false,
        // 是否忽略大小写。取值如下所示：
        // <li> true: （默认）大小写不敏感。  </li>
        // <li> false: 大小写敏感。 </li>
        ignore_case: true,
        // Referer 头部值是否必须以 HTTP 或者 HTTPS 开头。取值如下所示：
        // <li> true: 表示不以 HTTP 或者 HTTPS 开头的 Referer 头部值是合法的。在这个情况下，veImagex 会尝试将其与 Referers 列表匹配。  </li>
        // <li> false: （默认）表示不以 HTTP 或者 HTTPS 开头 Referer 头部值是非法的。在这个情况下，veImagex 判定为不匹配 CommonType 下的这个 Referers 列表。  </li>
        ignore_scheme: false,
      },
      // URL 鉴权配置
      url_auth: {
        // 是否开启 URL 鉴权配置，取值如下所示：
        // <li> true：是 </li>
        // <li> false：否 </li>
        enabled: true,
        // A 鉴权配置
        type_a: {
          // 主鉴权密钥
          main_sk: "SKSKSKSK",
          // 备用鉴权密钥
          backup_sk: "test",
          // md5hash 参数名
          sign_param: "sign",
          // 有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。
          expire_time: 1800,
        },
        // B 鉴权配置
        type_b: {
          // 主鉴权密钥
          main_sk: "01h9dh**01h9k",
          // 备用鉴权密钥
          backup_sk: "test",
          // 有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。
          expire_time: 1800,
        },
        // C 鉴权配置
        type_c: {
          // 主鉴权密钥
          main_sk: "01h9dh**01h9k",
          // 备用鉴权密钥
          backup_sk: "test",
          // 有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。
          expire_time: 1800,
        },
        // D 鉴权配置
        type_d: {
          // 主鉴权密钥
          main_sk: "01h9dh**01h9k",
          // 备用鉴权密钥
          backup_sk: "test",
          // md5hash 参数名
          sign_param: "sign",
          // 有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。
          expire_time: 1800,
          // TimeStamp 参数名
          time_param: "t",
          // 时间戳格式，取值如下所示：
          // <li> decimal：十进制（Unix 时间戳） </li>
          // <li> heximal：十六进制（Unix 时间戳） </li>
          time_format: "decimal",
        },
      },
      // IP 黑白名单配置
      ip_auth: {
        // 是否开启黑白名单配置，取值如下所示：
        // <li> true：开启黑白名单配置 </li>
        // <li> false：关闭黑白名单配置 </li>
        enabled: true,
        // 是否是 IP 白名单，取值如下所示：
        // <li> true：配置白名单 </li>
        // <li> false：配置黑名单 </li>
        is_white_mode: false,
        // 黑白名单 IP 地址，最大限制为 1000。
        values: ["192.0.2.0"],
      },
      // UA 访问限制配置
      user_agent_acl: {
        // 是否开启 UA 访问限制，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：未开启 </li>
        enabled: true,
        // 黑白名单设置类型，取值如下所示：
        // <li> deny：黑名单 </li>
        // <li> allow：白名单 </li>
        rule_type: "deny",
        // Agent 列表，最多可支持输入 1000 个，支持通配符 * 匹配任意字符串。
        user_agents: ["*IE*|*safari*"],
        // 表示是否允许 UA 为空或者不包含 UA 字段的请求访问加速域名。取值如下所示：
        // <li> true：允许 </li>
        // <li> false：不允许 </li>
        allow_empty: true,
      },
      // 区域访问限制，不传不更新
      area_acl: {
        // 是否开启区域限制，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：未开启 </li>
        enabled: true,
        // 黑白名单设置类型，取值如下所示：
        // <li> deny：黑名单 </li>
        // <li> allow：白名单 </li>
        rule_type: "deny",
        // 地区列表。取值请见[国家名称对照表](https://www.volcengine.com/docs/6454/131750)表格中国家简写该列内容。
        areas: ["Cambodia"],
      },
      // 高级配置
      advanced: {
        // 是否开启 IPV6，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_ipv6: true,
        // 是否开启 Gzip 压缩，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_gzip: true,
        // 是否开启 Brotli 压缩，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        // note：
        // 支持同时配置 Gzip 压缩和 Brotli 压缩，详细内容请参考[智能压缩](https://www.volcengine.com/docs/508/75858)。
        enable_br: true,
      },
      // HTTP 响应头配置
      resp_hdrs: [
        {
          // Header Key，请见[支持配置的响应头](https://www.volcengine.com/docs/508/196704#%E6%94%AF%E6%8C%81%E9%85%8D%E7%BD%AE%E7%9A%84%E5%93%8D%E5%BA%94%E5%A4%B4)。
          key: "Access-Control-Allow-Origin",
          // Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除美元符号（$），Delete（ASCII code 127）外的可打印 ASCII 字符。
          value: "*",
        },
      ],
      // 自适应格式配置
      adaptfmt: {
        // 是否开启自适应，取值如下所示：
        // <li> true：开启自适应 </li>
        // <li> false：关闭自适应 </li>
        enabled: true,
        // 自适应格式列表，支持以下取值：
        // <li> webp：WEBP 自适应 </li>
        // <li> heic：HEIC 自适应 </li>
        // <li> avif：AVIF 自适应 </li>
        adapt_formats: ["heic", "avif"],
        // 是否开启体积校验，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        check_adapt_fsize: true,
      },
      // 集智瘦身配置
      do_slim: {
        // 是否开启集智瘦身，取值如下所示：
        // <li> true：开启集智瘦身 </li>
        // <li> false：关闭集智瘦身 </li>
        enabled: true,
        // 是否关闭持久化。取值如下所示：
        // <li> true：关闭 </li>
        // <li> false：开启 </li>
        discard_slimed_file: true,
      },
      // 全球加速配置
      global_acceleration: {
        // 是否开启全球加速，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enabled: true,
      },
      // 远程鉴权设置
      remote_auth: {
        // 是否开启远程鉴权，取值如下所示：
        // <li> true：是 </li>
        // <li> false：否 </li>
        enabled: true,
        // 生效对象
        match_rule: [
          {
            // 匹配方式，取值如下所示：
            // <li> match：（默认）表示 object 匹配 Value。  </li>
            // <li> not_match：表示 object 不匹配 Value。  </li>
            // note：
            // 如果您创建了多个生效对象配置，每个配置中该参数的值必须相同。
            match_operator: "match",
            // 表示 veImageX 对哪些对象类型进行规则匹配。取值如下所示：
            // <li> filetype：表示特定后缀的文件。  </li>
            // <li> directory：表示特定文件目录下的所有文件。  </li>
            // <li> path：表示特定的文件。 </li>
            object: "directory",
            // 表示 Object 对应的具体对象，并且是大小写敏感的。参数值的长度不能超过 1,024 个字符。您可以指定一个或者多个对象。多个对象之间使用英文分号（;）分隔。该参数有以下说明：
            // <li> 如果 Object 是 filetype，您需要指定一个或者多个文件后缀。文件后缀可以包含英文字母和数字。多个文件后缀使用分号（;）分隔。例如 xlsx 或者 png;txt。  </li>
            // <li> 如果 Object 是 directory，您需要指定一个或者多个目录路径。多个目录路径使用分号（;）分隔。每个目录路径必须以斜杠（/）开头和结尾， </li>
            // note：
            // 例如 /www/img/volc/;/www/doc/。您可以使用 / 表示域名下的所有目录。同时，目录路径可以包含除了以下字符的可打印 ASCII 字符： 连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）
            // <li> 如果 Object 是 path，您需要指定一个或者多个文件路径。文件路径支持使用通配符（*）表示一个或者多个字符。多个文件路径使用分号（;）分隔。 </li>
            // tip
            // 例如 /www/img/volcano.png;/doc/study.docx。文件路径必须以 / 开头。同时，文件路径可以包含除了以下字符的可打印 ASCII 字符： 连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）
            value: "/www/img/volc/",
          },
        ],
        // 鉴权服务器设置
        auth_server: {
          // 鉴权服务器的主地址。主地址的格式是 <scheme>://<domain> 或 <scheme>://<ip>。该参数值的长度不能超过 100 个字符。
          // <li> <scheme> 的值是 http 或者 https。 </li>
          // <li> <domain> 的值不能是 localhost。 </li>
          // <li> <ip> 的值不能是 127.0.0.1。 </li>
          address: "http://www.testa.com",
          // 鉴权服务器的备地址。地址格式和要求与主地址 address 相同。
          backup_address: "http://www.testb.com",
          // 鉴权请求的路径。鉴权地址和请求路径组成了完整的鉴权 URL。veImageX 会把用户的请求转发到该鉴权 URL。取值如下所示：
          // <li> constant：表示鉴权请求中的路径与用户请求中的路径相同。  </li>
          // <li> variable：表示您需要在 pathValue 参数中指定一个鉴权请求中的路径。 </li>
          path_type: "constant",
          // 表示一个鉴权请求的路径，长度不能超过 100 个字符。路径必须以斜杠（/）开头，可以包含除了以下字符的可打印 ASCII 字符： 连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）
          path_value: "/sig",
          // 在发送鉴权请求时，veImageX 所使用的请求方法。取值如下所示：
          // <li> default：鉴权请求所使用的方法与用户的请求相同。  </li>
          // <li> get：鉴权请求使用 GET 方法。  </li>
          // <li> post：鉴权请求使用 POST 方法。  </li>
          // <li> head：鉴权请求使用 HEAD 方法。 </li>
          request_method: "default",
        },
        // 鉴权请求参数设置
        auth_request_query: {
          // 表示鉴权请求是否包含用户请求 URL 中的查询参数。取值如下所示：
          // <li> exclude：表示鉴权请求不包含任何查询参数。  </li>
          // <li> include：表示鉴权请求包含所有查询参数。  </li>
          // <li> includePart：表示鉴权请求包含指定的查询参数。 </li>
          action: "includePart",
          // 表示 Action 参数所对应的参数值，长度不能超过1,024 个字符。该参数有以下说明：
          // <li> 如果 Action 是 exclude 或 include，Value 必须是 *。  </li>
          // <li> 如果 Action 是 includePart，您需要在 Value 参数中指定用户请求 URL 中的一个或者多个查询参数，多个查询参数使用英文分号（;）分隔。您不能指定 *。查询参数是区分大小写的，可以包含除了以下字符的可打印 ASCII 字符： 双引号（"）、空格、Delete（ASCII code 127） 该参数的默认值是 *。 </li>
          value: "header1;header2",
          // 表示鉴权请求中额外的参数设置。您最多可以设置 50 个参数。
          query: [
            {
              // 您需要设置的鉴权请求参数，长度不能超过 1,024 个字符。鉴权请求参数可以包含除了以下字符的可打印 ASCII 字符： 双引号（"）、空格、Delete（ASCII code 127）
              key: "new_host",
              // 您在 Key 中设置的鉴权请求参数的类型。ValueType 有以下取值：
              // <li> constant：表示鉴权请求参数是一个常量。此时，您需要在 Value 中指定该常量的值。  </li>
              // <li> variable：表示鉴权请求参数的值来自一个变量。参见 Value 的说明。 </li>
              value_type: "variable",
              // 鉴权请求参数的值，长度不能超过 1,024 个字符，并且区分大小写。Value 有以下取值：
              // <li> 当 ValueType 是 constant 时，表示鉴权请求参数的值是一个常量。您需要指定该常量值。常量值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符： 双引号（"）、Delete（ASCII code 127）  </li>
              // <li> 当 ValueType 是 variable 时，表示鉴权请求参数的值来自一个变量。您可以指定该变量列表中的变量。 </li>
              value: "host",
            },
          ],
        },
        // 鉴权请求头设置
        auth_request_header: {
          // 鉴权请求中 HOST 头部的值。该参数的默认值是 default，表示 HOST 头部的值与您的加速域名相同。
          host: "default",
          // 鉴权请求头是否包含用户请求头。取值如下所示：
          // <li> exclude：表示鉴权请求头中不包含任何用户请求头。  </li>
          // <li> include：表示鉴权请求头中包含所有用户请求头。  </li>
          // <li> includePart：表示鉴权请求头包含指定的用户请求头。 </li>
          action: "exclude",
          // 表示 Action 参数所对应的参数值，长度不能超过 1,024 个字符。该参数有以下说明：
          // <li> 如果 Action 是 exclude 或 include，Value 必须是 *。  </li>
          // <li> 如果 Action 是 includePart，Value 参数的取值是用户请求中的一个或者多个头部。多个头部使用英文分号（;）分隔。其取值不能只是 *，可以包含除了以下字符的可打印 ASCII 字符： 下划线（_）、空格、双引号（"），Delete（ASCII code 127） 该参数的默认值是 *。 </li>
          value: "*",
          // 表示鉴权请求中额外的请求头设置。您最多可以设置 50 个请求头。
          header: [
            {
              // 您需要设置的请求头。请求头不能是 host，长度不能超过 1,024 个字符，并且不区分大小写。请求头可以包含除了以下字符的可打印 ASCII 字符： 下划线（_）、双引号（"）、空格、Delete（ASCII code 127）
              key: "header1",
              // 请求头的类型。取值如下所示：
              // <li> constant：表示请求头的值是一个常量。您需要在 Value 参数中指定该常量的值。  </li>
              // <li> variable：表示请求头的值来自一个变量。参见 Value 的说明。 </li>
              value_type: "h",
              // 表示请求头的值。取值如下所示：
              // <li> 当 ValueType 是 constant 时，您需要指定一个常量值。该常量值的长度不能超过 1,024 个字符，并且区分大小写。同时，该常量值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符： 双引号（"）、Delete（ASCII code 127）  </li>
              // <li> 当 ValueType 是 variable 时，表示请求头的值来自一个变量。您可以指定该变量列表中的变量。 </li>
              value: "constant",
            },
          ],
        },
        // 鉴权响应设置
        auth_response: {
          // 鉴权服务器状态码设置
          auth_server_status_code: {
            // 指定鉴权失败时的鉴权状态码。默认值是 401。
            // <li> 您可以指定范围在 400-499 中的一个或者多个状态码。多个状态码使用英文分号（;）分隔。 </li>
            // <li> 您也可以指定 4xx 表示 400-499 中的任意一个状态码。 </li>
            fail_code: "407",
            // 指定鉴权成功时的鉴权状态码。默认值是 200。
            // <li> 您可以指定范围在 200-299 中的一个或者多个状态码。多个状态码使用英文分号（;）分隔。 </li>
            // <li> 您也可以指定 2xx 表示 200-299 中的任意一个状态码。 </li>
            success_code: "200",
            // 如果鉴权状态码既不是 FailCode，又不是 SuccessCode 时，veImageX 处理鉴权请求的方式。取值如下所示：
            // <li> reject：veImageX 认为鉴权失败。  </li>
            // <li> pass：veImageX 认为鉴权成功。 </li>
            default_action: "reject",
          },
          // 鉴权结果缓存设置
          auth_result_cache: {
            // veImageX 是否缓存鉴权状态码。取值如下所示：
            // <li> nocache：veImageX 不缓存鉴权状态码。  </li>
            // <li> cache：veImageX 缓存鉴权状态码。 </li>
            action: "nocache",
            // 缓存 key 指定了用于区分不同请求 URI 的查询参数。可以指定[变量字段说明](https://www.volcengine.com/docs/508/1171078)中的参数, 必须包含 URI。
            cache_key: ["[$URI,$host]"],
            // 鉴权状态码的缓存时间。单位是秒。取值范围是 [1,86400]。86400 秒表示 24 小时。
            ttl: 5,
          },
          // 鉴权服务超时时间
          auth_server_timeout: {
            // 鉴权超时的时间，单位是毫秒。默认值为 200，取值范围是 [200,3600]。
            time: 200,
            // 鉴权超时后 veImageX 处理鉴权请求的策略。取值如下所示：
            // <li> reject：veImageX 认为鉴权失败。  </li>
            // <li> pass：veImageX 认为鉴权成功。 </li>
            action: "reject",
          },
          // 响应设置
          response: {
            // 鉴权失败时 veImageX 响应用户的状态码。取值范围为 [400,499] 。默认值是 403。
            fail_code: "403",
          },
        },
      },
      // 页面优化设置，仅素材托管服务下域名支持配置。
      page_optimization: {
        // 是否开启页面优化，取值如下所示：
        // <li> true：是 </li>
        // <li> false：否 </li>
        enabled: true,
        // 表示需要优化的对象列表。该参数有以下取值：
        // <li> html: （默认）表示 HTML 页面。  </li>
        // <li> js: 表示 Javascript 代码。  </li>
        // <li> css: 表示 CSS 代码。  </li>
        // note：
        // 如果对象列表包含 js 或者 js，html 也必须被包含。
        optimization_type: ["html", "css"],
      },
      // 共享缓存配置。共享缓存允许同账号下多个加速域名共享同一份节点上的缓存。在 veImageX 中，您可以通过设置共享缓存配置，使各个子站点之间可共享相同的公共资源，以减少带宽的使用，提高资源命中率。详细功能说明参看[共享缓存](https://www.volcengine.com/docs/508/196769)。
      // note：
      // 共享缓存为白名单功能，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000080)联系技术支持为您的账号开启配置能力。
      share_cache: {
        // 共享域名。
        domains: ["test1.imagex.cn", "test2.imagex.cn"],
      },
    };

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

更新响应头配置

您可以调用 UpdateResponseHeader 接口更新响应头配置。详细的参数说明可参见 UpdateResponseHeader 接口文档。

接口调用示例如下所示。

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

export async function UpdateResponseHeaderDemo() {
  try {
    const Client = 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。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "uh****7d",
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domain: "a.imagex.cn",
      // Resp Headers 配置
      resp_hdrs: [
        {
          // Header Key，请见[支持配置的响应头](https://www.volcengine.com/docs/508/196704#%E6%94%AF%E6%8C%81%E9%85%8D%E7%BD%AE%E7%9A%84%E5%93%8D%E5%BA%94%E5%A4%B4)。
          key: "Access-Control-Allow-Origin",
          // Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除美元符号（$），Delete（ASCII code 127）外的可打印 ASCII 字符。
          value: "*",
          // 在 veImageX 响应用户请求时，是否校验请求头中的 Origin 字段。仅对响应头部Access-Control-Allow-Origin有效，取值如下所示：
          // <li> true：开启校验，veImageX 会校验 Origin 字段。 </li>
          // <li> 如果校验成功，响应头中会包含 Access-Control-Allow-Origin 字段。字段值与 Origin 字段值相同。 </li>
          // <li> 如果校验失败，响应头中不会包含 Access-Control-Allow-Origin 字段。 </li>
          // <li> false：关闭校验，veImageX 不会校验 Origin 字段。响应头中将始终包含 Access-Control-Allow-Origin 头部和您配置的值。 </li>
          access_origin_control: true,
        },
      ],
    };

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

更新默认域名配置

您可以调用 SetDefaultDomain 接口更新默认域名配置。详细的参数说明可参见 SetDefaultDomain 接口文档。

接口调用示例如下所示。

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

export async function SetDefaultDomainDemo() {
  try {
    const Client = 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 = {
      // 指定新的默认域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      Domain: "test.com.cn",
    };

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

更新 Referer 防盗链配置

您可以调用 UpdateRefer 接口更新 Referer 防盗链配置。详细的参数说明可参见 UpdateRefer 接口文档。

接口调用示例如下所示。

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

export async function UpdateReferDemo() {
  try {
    const Client = 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。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "9h**09",
      // Referer 配置
      refer_link: {
        // 是否开启 Referer 访问限制，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enabled: true,
        // 是否选择白名单模式，取值如下所示：
        // <li> true：选择白名单 </li>
        // <li> false：选择黑名单 </li>
        is_white_mode: true,
        // Referer 通用规则列表，根据是否为白名单，为对应的白/黑名单的值。您可以指定一个或者多个 IP 地址，域名和泛域名。支持填写二级域名，支持混合输入。
        // <li> IP 地址格式支持 IPv4 和 IPv6，最多可输入 1000 个 IP 地址。 </li>
        // <li> 域名无需包含http:// 或 https://。 </li>
        // note：
        // <li> values 和 regex_valses 均存在时，两者同时生效。 </li>
        // <li> 若您需要对同类型名单内已设定的 values 地址进行增删处理，那么您可调用 [获取域名配置](https://www.volcengine.com/docs/508/9366#refer-link) 接口获取已配置的全部地址列表后，在此基础上添加或删除您期望变更的值，最后重新传入 values。 </li>
        values: ["test.example.com", "*.example.com", "10.0.0.1"],
        // Referer 的正则表达式的列表，仅支持填写 IPv4 和 IPv6 格式的 IP 地址，参数长度范围为（1，1024）。不支持域名、泛域名、CIDR 网段。最多支持设置 100 条规则。
        regex_values: ["192.23.1.8"],
        // 是否允许空 Referer 访问，取值如下所示：
        // <li> true：允许 </li>
        // <li> false：不允许 </li>
        allow_empty_refer: false,
        // 是否启用正则表达列表，取值如下所示：
        // <li> true：启用 </li>
        // <li> false：不启用 </li>
        regex_values_enabled: true,
      },
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domain: "http://test.com",
    };

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

更新 https 配置

您可以调用 UpdateHttps 接口更新 https 配置。详细的参数说明可参见 UpdateHttps 接口文档。

接口调用示例如下所示。

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

export async function UpdateHttpsDemo() {
  try {
    const Client = 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。
      // <li> 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "uh****2h",
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domain: "test.volcimagextest.com",
      // https 配置
      https: {
        // 是否开启 http2，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_http2: true,
        // 是否开启 https，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_https: true,
        // 是否开启 ocsp 装订，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_ocsp: true,
        // 是否开启 quic 协议支持，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_quic: true,
        // 支持的 tls 版本，取值如下所示：
        // <li> tlsv1.0 </li>
        // <li> tlsv1.1 </li>
        // <li> tlsv1.2 </li>
        // <li> tlsv1.3  </li>
        tls_versions: ["tlsv1.0", "tlsv1.1", "tlsv1.2"],
        // 需要关联的证书 ID，若enable_https为true，则为必填。
        cert_id: "fa2f32dfe**e8c2105ef0d711f15",
        // 是否开启强制跳转，支持取值如下所示：
        // <li> true：开启 </li>
        // <li> false：关闭 </li>
        enable_force_redirect: false,
        // 强制跳转类型，取值如下所示：
        // <li> http2https：HTTP 到 HTTPS </li>
        // <li> https2http：HTTPS 到 HTTP </li>
        // note：
        // 仅当enable_force_redirect取值为true时需要配置。
        force_redirect_type: "https2http",
        // 强制跳转状态码，取值如下所示：
        // <li> 301：返回给用户 301 状态码进行重定向。 </li>
        // <li> 302：返回给用户 302 状态码进行重定向。 </li>
        // note：
        // 仅当enable_force_redirect取值为true时需要配置。
        force_redirect_code: "301",
      },
    };

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

更新 IP 黑白名单配置

您可以调用 UpdateImageDomainIPAuth 接口更新 IP 黑白名单配置。详细的参数说明可参见 UpdateImageDomainIPAuth 接口文档。

接口调用示例如下所示。

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

export async function UpdateImageDomainIPAuthDemo() {
  try {
    const Client = 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。
      // <li> 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "098**ud9",
      // 待修改配置的域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domain: "example.imagex.com",
      // 黑白名单配置
      ip_auth: {
        // 是否开启黑白名单配置，取值如下所示：
        // <li> true：开启黑白名单配置 </li>
        // <li> false：关闭黑白名单配置 </li>
        enabled: true,
        // 是否是 IP 白名单，取值如下所示：
        // <li> true：配置白名单 </li>
        // <li> false：配置黑名单 </li>
        is_white_mode: true,
        // 黑白名单 IP 地址，您可以指定一个或者多个 IP 地址（如 192.0.2.0）和 IP 地址网段（192.0.2.0/24）。IP 地址和网段可以是 IPv4 或 IPv6 格式，可混合填写，最多可输入 1000 个地址。
        // warning：
        // 若您需要对同类型名单内已设定的 values 地址进行增删处理，那么您可调用 [获取域名配置](https://www.volcengine.com/docs/508/9366#ip-auth) 接口获取已配置的全部地址列表后，在此基础上添加或删除您期望变更的地址，最后重新传入 values。
        values: ["192.0.2.0", "192.0.2.0/24"],
      },
    };

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

更新 UA 黑白名单配置

您可以调用 UpdateImageDomainUaAccess 接口更新 UA 黑白名单配置。详细的参数说明可参见 UpdateImageDomainUaAccess 接口文档。

接口调用示例如下所示。

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

export async function UpdateImageDomainUaAccessDemo() {
  try {
    const Client = 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。
      // <li> 您可以在veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "qhc***uslz",
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domain: "123***.volcimagextest.com",
      // UA 访问限制配置。
      ua_auth: {
        // 是否开启 UA 访问限制，取值如下所示：
        // <li> true：开启 </li>
        // <li> false：未开启（默认） </li>
        enable: true,
        // 黑白名单设置类型，取值如下所示：
        // <li> deny：黑名单 </li>
        // <li> allow：白名单（默认） </li>
        rule_type: "deny",
        // Agent 列表，最多可支持输入 1000 个，支持通配符 * 匹配任意字符串。输入多个时以 | 分割，或者一行仅输入一个。
        // warning：
        // 若您需要对同类型名单内已设定的 Agent 列表进行增删处理，那么您可调用 [获取域名配置](https://www.volcengine.com/docs/508/9366#ua-list) 接口获取已配置的全部列表后，在此基础上添加或删除您期望变更的值，最后重新传入 user_agents。
        user_agents: ["road"],
        // 是否允许 UA 为空或者不包含 UA 字段的请求访问加速域名。取值如下所示：
        // <li> true：允许 </li>
        // <li> false：不允许 </li>
        allow_empty: true,
      },
    };

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

更新地域访问限制配置

您可以调用 UpdateImageDomainAreaAccess 接口更新地域访问限制配置。详细的参数说明可参见 UpdateImageDomainAreaAccess 接口文档。

接口调用示例如下所示。

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

export async function UpdateImageDomainAreaAccessDemo() {
  try {
    const Client = 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。
      // <li> 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "8ji**as0",
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      domain: "test.volcimagextest.com",
      // 区域访问限制配置
      area_access: {},
    };

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

更新域名自适应格式配置

您可以调用 UpdateDomainAdaptiveFmt 接口更新域名自适应格式配置。详细的参数说明可参见 UpdateDomainAdaptiveFmt 接口文档。

接口调用示例如下所示。

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

export async function UpdateDomainAdaptiveFmtDemo() {
  try {
    const Client = 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。
      // <li> 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "8ji**as0",
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      Domain: "test.volcimagextest.com",
      // 是否开启自适应，取值如下所示：
      // <li> true：开启自适应 </li>
      // <li> false：关闭自适应 </li>
      AdaptFmt: true,
      // 自适应格式列表，取值如下所示：
      // <li> webp：WEBP 自适应 </li>
      // <li> heic：HEIC 自适应 </li>
      // <li> avif：AVIF 自适应 </li>
      AdaptFormats: ["heic"],
      // 是否开启体积校验，取值如下所示：
      // <li> true：开启。开启后会对经自适应编码后的图片体积和编码前原图体积进行对比，若编码后体积更小则输出编码后图片；否则输出原图。 </li>
      // <li> false：关闭 </li>
      CheckAdaptFsize: false,
    };

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

更新集智瘦身配置

您可以调用 UpdateSlimConfig 接口更新集智瘦身配置。详细的参数说明可参见 UpdateSlimConfig 接口文档。

接口调用示例如下所示。

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

export async function UpdateSlimConfigDemo() {
  try {
    const Client = 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。
      // <li> 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "9k**82",
      // 是否开启集智瘦身，取值如下所示：
      // <li> true：开启集智瘦身 </li>
      // <li> false：关闭集智瘦身 </li>
      DoSlim: true,
      // 域名，您可以通过[获取服务下全部域名](https://www.volcengine.com/docs/508/9379)获取服务下域名信息。
      Domain: "a.image.com",
      // 是否关闭持久化。取值如下所示：
      // <li> true：关闭 </li>
      // <li> false：开启 </li>
      DiscardSlimedFile: false,
    };

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

更新域名高级配置

您可以调用 UpdateAdvance 接口更新域名高级配置。详细的参数说明可参见 UpdateAdvance 接口文档。

接口调用示例如下所示。

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

export async function UpdateAdvanceDemo() {
  try {
    const Client = 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 = {};

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

更新下载限速配置

您可以调用 UpdateImageDomainDownloadSpeedLimit 接口更新下载限速配置。详细的参数说明可参见 UpdateImageDomainDownloadSpeedLimit 接口文档。

接口调用示例如下所示。

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

export async function UpdateImageDomainDownloadSpeedLimitDemo() {
  try {
    const Client = 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。您可以在 veImageX 控制台[服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。您也可以通过调用 [GetAllImageServices](https://www.volcengine.com/docs/508/9360) 接口方式获取服务 ID。
      ServiceId: "服务ID",
      // 域名。您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379)接口获取域名。
      domain: "a.imagex.cn",
      // 下载限速配置
      download_speed_limit: {},
    };

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

获取域名配置

您可以调用 GetDomainConfig 接口获取域名配置。详细的参数说明可参见 GetDomainConfig 接口文档。

接口调用示例如下所示。

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

export async function GetDomainConfigDemo() {
  try {
    const Client = 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 = {
      // 域名，您可以通过调用 [GetServiceDomains](https://www.volcengine.com/docs/508/9379) 获取当前服务下所有域名。
      DomainName: "example.volcimagex.cn",
      // 服务 ID。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "yl***yn",
    };

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

获取服务下全部域名

您可以调用 GetServiceDomains 接口获取服务下全部域名。详细的参数说明可参见 GetServiceDomains 接口文档。

接口调用示例如下所示。

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

export async function GetServiceDomainsDemo() {
  try {
    const Client = 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。
      // <li> 您可以在veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。 </li>
      // <li> 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。 </li>
      ServiceId: "89**0j",
    };

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

获取响应头允许的 Key 列表

您可以调用 GetResponseHeaderValidateKeys 接口获取响应头允许的 Key 列表。详细的参数说明可参见 GetResponseHeaderValidateKeys 接口文档。

接口调用示例如下所示。

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

export async function GetResponseHeaderValidateKeysDemo() {
  try {
    const Client = 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 = {};

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

最近更新时间：2025.12.19 14:28:03

这个页面对您有帮助吗？

有用

无用

veImageX

调用说明 #

前提条件 #

调用示例 #

新增域名 #

删除域名 #

更新域名配置 #

更新响应头配置 #

更新默认域名配置 #

更新 Referer 防盗链配置 #

更新 https 配置 #

更新 IP 黑白名单配置 #

更新 UA 黑白名单配置 #

更新地域访问限制配置 #

更新域名自适应格式配置 #

更新集智瘦身配置 #

更新域名高级配置 #

更新下载限速配置 #

获取域名配置 #

获取服务下全部域名 #

获取响应头允许的 Key 列表 #

调用说明

前提条件

调用示例

新增域名

删除域名

更新域名配置

更新响应头配置

更新默认域名配置

更新 Referer 防盗链配置

更新 https 配置

更新 IP 黑白名单配置

更新 UA 黑白名单配置

更新地域访问限制配置

更新域名自适应格式配置

更新集智瘦身配置

更新域名高级配置

更新下载限速配置

获取域名配置

获取服务下全部域名

获取响应头允许的 Key 列表