tencentcloud-sdk-nodejs-clb 4.0.1015 → 4.0.1038

package/README.md

@@ -1,36 +1,66 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。
-为方便 NODEJS 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 NODEJS 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
+欢迎使用腾讯云开发者工具套件（SDK），Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
+为方便 Node.js 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 Node.js 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
 
 # 依赖环境
 
-1. NODEJS 10.0.0 版本及以上
-2. 从腾讯云控制台 开通相应产品
-3. 获取 SecretID、SecretKey 以及调用地址（endpoint），endpoint 一般形式为\*.tencentcloudapi.com，如 CVM 的调用地址为 cvm.tencentcloudapi.com，具体参考各产品说明。
+1. Node.js 10.0.0 版本及以上。
+2. 注意：部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
 
 # 获取安装
 
-安装 NODEJS SDK 前，先获取安全凭证。在第一次使用云 API 之前，用户首先需要在腾讯云控制台上申请安全凭证，安全凭证包括 SecretID 和 SecretKey， SecretID 是用于标识 API 调用者的身份，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。
+使用 SDK 需要 API 密钥，可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请，API 密钥包括 SecretID 和 SecretKey，密钥须严格保管，避免泄露。
 
-## 通过 Npm 安装
+## 通过 npm 安装
 
-通过 npm 获取安装是使用 NODEJS SDK 的推荐方法，npm 是 NODEJS 的包管理工具。关于 npm 详细可参考[ npm 官网](https://www.npmjs.com/) 。
+通过 npm 获取安装是使用 Node.js SDK 的推荐方法，关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
 
-1. 执行以下安装命令：
-   > npm install tencentcloud-sdk-nodejs --save
-2. 在您的代码中引用对应模块代码，可参考示例。
-3. 如上引用方式会将腾讯云所有产品sdk下载到本地，可以将tencentcloud-sdk-nodejs换成tencentcloud-sdk-nodejs-cvm/cbs/vpc等，即可引用特定产品的sdk，代码中可将require("tencentcloud-sdk-nodejs")改为require("tencentcloud-sdk-nodejs-cvm/cbs/vpc")，其余不变，可参考示例，可大大节省存储空间。
+### 安装指定产品 SDK（推荐）
+
+安装 CVM SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-cvm --save
+```
+
+安装 VPC SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-vpc --save
+```
+
+具体产品的缩写表请参考 [products.md](./products.md) 中的包名字段。
+
+安装指定产品 SDK 后，注意修改引入的包名：
+
+```diff
+- const tencentcloud = require("tencentcloud-sdk-nodejs")
++ const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
+
+- const CvmClient = tencentcloud.cvm.v20170312.Client
++ const CvmClient = cvm.v20170312.Client
+```
+
+### 安装全产品 SDK
+
+```
+npm install tencentcloud-sdk-nodejs --save
+```
+
+全产品 SDK 包含了所有云产品的调用代码，体积偏大，对体积敏感的场景，推荐安装指定产品 SDK。
 
 ## 通过源码包安装
 
-1. 前往 [Github 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
+1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
 2. 解压源码包到您项目合适的位置，例如 `sdk/tencentcloud-sdk-nodejs`。
 3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
-4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入sdk，具体可参考示例。
+4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK，具体可参考示例。
 
 # 示例
 
+以云服务器产品查询可用区列表接口为例。
+
 ```js
 const tencentcloud = require("tencentcloud-sdk-nodejs")
 
@@ -73,7 +103,7 @@ client.DescribeZones().then(
 )
 ```
 
-在支持 typescript 项目中，采用如下方式调用
+在支持 TypeScript 项目中，采用如下方式调用
 
 ```js
 import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -83,10 +113,11 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 // ...
 ```
 
-实例化`Client` 的入参支持 `clientConfig` 数据结构和说明 详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
+实例化 `Client` 的入参支持 `clientConfig`，数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
 
 ## Common Client
-从 4.0.714 版本开始腾讯云 NODEJS SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
+
+从 4.0.714 版本开始，腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
 
 **注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
 
@@ -94,19 +125,19 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 
 ## 更多示例
 
-更丰富的使用 demo 请在 examples 目录中寻找。
+请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
 
 # 相关配置
 
 ## 代理
 
-如果是有代理的环境下，需要配置代理，请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
+如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
 
 # 凭证管理
 
 除显式传入凭证外，从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
 
-在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
+在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
 ```javascript
 // ...
 const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
@@ -118,20 +149,16 @@ new XxxClient({
 })
 ```
 
-# 旧版 SDK
-
-我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[github 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
-
 # 常见问题
-- webpack打包出错/浏览器报错
+- webpack 打包出错/浏览器报错
 
-  请**务必不要**将此sdk直接用于web前端(包括小程序等)，暴露密钥在这些环境非常不安全。
+  请**务必不要**将此 SDK 直接用于 Web 前端（包括小程序等），暴露密钥在这些环境非常不安全。
 
-  正确的做法是在自己的服务端引用此sdk，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
+  正确的做法是在自己的服务端引用此 SDK，并保存好密钥，做好请求鉴权，前端再调用服务端执行业务流程。
 
 - `The "original" argument must be of type Function.`
 
-  通常是因为nodejs版本低于 `v10` ，或处于非node环境，请再次确认执行环境。
+  通常是因为 Node.js 版本低于 `v10` ，或处于非 Node.js 环境，请再次确认执行环境。
 
 - 请求不通
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-clb",
-  "version": "4.0.1015",
+  "version": "4.0.1038",
   "description": "Tencent Cloud API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

package/src/services/clb/v20180317/clb_client.ts

@@ -25,6 +25,7 @@ import {
   SetLoadBalancerSecurityGroupsResponse,
   RulesItems,
   ExtraInfo,
+  ClassicalListener,
   BatchModifyTargetWeightResponse,
   SetSecurityGroupForLoadbalancersRequest,
   CreateLoadBalancerRequest,
@@ -32,7 +33,7 @@ import {
   DeleteRuleRequest,
   CloneLoadBalancerRequest,
   DisassociateTargetGroupsResponse,
-  SetLoadBalancerStartStatusResponse,
+  ListenerBackend,
   SetLoadBalancerClsLogResponse,
   DescribeLoadBalancerTrafficResponse,
   MultiCertInfo,
@@ -44,17 +45,20 @@ import {
   ModifyLoadBalancerAttributesResponse,
   DescribeTargetGroupInstancesRequest,
   DescribeIdleLoadBalancersResponse,
-  AssociateTargetGroupsRequest,
+  BindItem,
   DescribeLoadBalancersRequest,
+  AddCustomizedConfigRequest,
   ClassicalTarget,
   ListenerItem,
   RsWeightRule,
   RegisterFunctionTargetsRequest,
   DeregisterTargetsFromClassicalLBRequest,
   InquiryPriceModifyLoadBalancerRequest,
+  ModifyCustomizedConfigRequest,
   BasicTargetGroupInfo,
   ModifyTargetWeightResponse,
   ZoneResource,
+  AssociateTargetGroupsRequest,
   DescribeTaskStatusRequest,
   TargetGroupInstance,
   DescribeClassicalLBByInstanceIdResponse,
@@ -63,7 +67,7 @@ import {
   RuleHealth,
   DescribeExclusiveClustersResponse,
   ModifyDomainRequest,
-  IdleLoadBalancer,
+  DisassociateCustomizedConfigResponse,
   BatchModifyTargetTagRequest,
   RegisterTargetGroupInstancesResponse,
   ClassicalTargetInfo,
@@ -73,6 +77,7 @@ import {
   DescribeTargetGroupsResponse,
   LoadBalancerHealth,
   InquiryPriceCreateLoadBalancerRequest,
+  ModifyFunctionTargetsResponse,
   DeleteLoadBalancerListenersRequest,
   BlockedIP,
   ModifyRuleResponse,
@@ -81,9 +86,10 @@ import {
   DeregisterFunctionTargetsResponse,
   DescribeCustomizedConfigListRequest,
   AutoRewriteRequest,
+  IdleLoadBalancer,
   DescribeCrossTargetsResponse,
   FunctionInfo,
-  ModifyFunctionTargetsResponse,
+  ModifyCustomizedConfigResponse,
   DescribeLoadBalancerListByCertIdResponse,
   ModifyTargetGroupInstancesWeightResponse,
   DescribeTargetGroupsRequest,
@@ -96,6 +102,7 @@ import {
   Target,
   DescribeLoadBalancerTrafficRequest,
   DescribeBlockIPListRequest,
+  MigrateClassicalLoadBalancersResponse,
   CertIdRelatedWithLoadBalancers,
   ItemPrice,
   DescribeClassicalLBHealthStatusResponse,
@@ -106,13 +113,14 @@ import {
   SpecAvailability,
   ConfigListItem,
   RegisterTargetsWithClassicalLBRequest,
+  HealthCheck,
   ModifyDomainAttributesResponse,
   ReplaceCertForLoadBalancersResponse,
   DescribeTargetsResponse,
   ModifyListenerRequest,
   DeregisterTargetGroupInstancesResponse,
   RegisterTargetsRequest,
-  HealthCheck,
+  DisassociateCustomizedConfigRequest,
   AssociateTargetGroupsResponse,
   CreateTopicRequest,
   DeleteListenerRequest,
@@ -139,9 +147,10 @@ import {
   CreateClsLogSetResponse,
   Backend,
   LBChargePrepaid,
-  ClassicalListener,
+  AddCustomizedConfigResponse,
   DeleteLoadBalancerRequest,
   ModifyLoadBalancersProjectRequest,
+  AssociateCustomizedConfigRequest,
   CertificateInput,
   ResourceAvailability,
   SetLoadBalancerSecurityGroupsRequest,
@@ -149,7 +158,7 @@ import {
   SetCustomizedConfigForLoadBalancerRequest,
   CreateListenerResponse,
   CreateTargetGroupResponse,
-  MigrateClassicalLoadBalancersResponse,
+  AssociateCustomizedConfigResponse,
   CreateLoadBalancerSnatIpsResponse,
   ClassicalLoadBalancerInfo,
   DescribeListenersResponse,
@@ -215,7 +224,7 @@ import {
   Price,
   ModifyTargetGroupInstancesPortRequest,
   BatchRegisterTargetsRequest,
-  ListenerBackend,
+  DeleteCustomizedConfigResponse,
   SetSecurityGroupForLoadbalancersResponse,
   RuleInput,
   TagInfo,
@@ -226,6 +235,7 @@ import {
   DescribeClassicalLBListenersResponse,
   DescribeExclusiveClustersRequest,
   ModifyLoadBalancerSlaRequest,
+  SetLoadBalancerStartStatusResponse,
   DescribeBlockIPTaskRequest,
   Resource,
   CreateLoadBalancerResponse,
@@ -234,6 +244,7 @@ import {
   Quota,
   SetLoadBalancerClsLogRequest,
   LBItem,
+  DeleteCustomizedConfigRequest,
   ModifyTargetGroupAttributeResponse,
   DeleteLoadBalancerListenersResponse,
   DescribeIdleLoadBalancersRequest,
@@ -333,6 +344,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("ModifyTargetGroupInstancesWeight", req, cb)
   }
 
+  /**
+   * 关联配置到server或location，根据配置类型关联到server或location。准备下线，请使用SetCustomizedConfigForLoadBalancer。
+   */
+  async AssociateCustomizedConfig(
+    req: AssociateCustomizedConfigRequest,
+    cb?: (error: string, rep: AssociateCustomizedConfigResponse) => void
+  ): Promise<AssociateCustomizedConfigResponse> {
+    return this.request("AssociateCustomizedConfig", req, cb)
+  }
+
   /**
    * DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
    */
@@ -480,6 +501,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DeleteRewrite", req, cb)
   }
 
+  /**
+   * 去关联个性化配置，准备下线，请使用SetCustomizedConfigForLoadBalancer。
+   */
+  async DisassociateCustomizedConfig(
+    req: DisassociateCustomizedConfigRequest,
+    cb?: (error: string, rep: DisassociateCustomizedConfigResponse) => void
+  ): Promise<DisassociateCustomizedConfigResponse> {
+    return this.request("DisassociateCustomizedConfig", req, cb)
+  }
+
   /**
      * SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置（绑定、解绑）安全组操作。查询一个负载均衡实例目前已绑定的安全组，可使用 DescribeLoadBalancers 接口。本接口是set语义，
 绑定操作时，入参需要传入负载均衡实例要绑定的所有安全组（已绑定的+新增绑定的）。
@@ -557,6 +588,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("ModifyListener", req, cb)
   }
 
+  /**
+   * 删除个性化配置，准备下线，请使用SetCustomizedConfigForLoadBalancer。
+   */
+  async DeleteCustomizedConfig(
+    req: DeleteCustomizedConfigRequest,
+    cb?: (error: string, rep: DeleteCustomizedConfigResponse) => void
+  ): Promise<DeleteCustomizedConfigResponse> {
+    return this.request("DeleteCustomizedConfig", req, cb)
+  }
+
   /**
    * 查询用户在当前地域支持可用区列表和资源列表。
    */
@@ -818,6 +859,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("CreateRule", req, cb)
   }
 
+  /**
+   * 新增个性化配置，准备下线，请使用SetCustomizedConfigForLoadBalancer。
+   */
+  async AddCustomizedConfig(
+    req: AddCustomizedConfigRequest,
+    cb?: (error: string, rep: AddCustomizedConfigResponse) => void
+  ): Promise<AddCustomizedConfigResponse> {
+    return this.request("AddCustomizedConfig", req, cb)
+  }
+
   /**
      * ModifyDomain接口用来修改负载均衡七层监听器下的域名。
 本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
@@ -881,6 +932,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DeleteRule", req, cb)
   }
 
+  /**
+   * 修改个性化配置。如果配置已经绑定clb、server或location，同时更新。准备下线，请使用SetCustomizedConfigForLoadBalancer。
+   */
+  async ModifyCustomizedConfig(
+    req: ModifyCustomizedConfigRequest,
+    cb?: (error: string, rep: ModifyCustomizedConfigResponse) => void
+  ): Promise<ModifyCustomizedConfigResponse> {
+    return this.request("ModifyCustomizedConfig", req, cb)
+  }
+
   /**
    * 本接口用于查询异步任务的执行状态，对于非查询类的接口（创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等），在接口调用成功后，都需要使用本接口查询任务最终是否执行成功。
    */