tencentcloud-sdk-nodejs-cdb 4.0.1026 → 4.0.1032

package/README.md

@@ -1,21 +1,20 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（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/) 。
 
 ### 安装指定产品 SDK（推荐）
 
@@ -56,10 +55,12 @@ npm install tencentcloud-sdk-nodejs --save
 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")
 
@@ -102,7 +103,7 @@ client.DescribeZones().then(
 )
 ```
 
-在支持 typescript 项目中，采用如下方式调用
+在支持 TypeScript 项目中，采用如下方式调用
 
 ```js
 import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -112,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 包，即可向任何产品发起调用。
 
 **注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
 
@@ -123,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
@@ -147,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-cdb",
-  "version": "4.0.1026",
+  "version": "4.0.1032",
   "description": "Tencent Cloud API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

package/src/services/cdb/v20170320/cdb_client.ts

@@ -1328,8 +1328,9 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 该接口（ModifyProtectMode）用于修改实例的同步方式。
-   */
+     * 该接口（ModifyProtectMode）用于修改实例的同步方式。
+说明：仅专属集群可调用，该接口即将下线。
+     */
   async ModifyProtectMode(
     req: ModifyProtectModeRequest,
     cb?: (error: string, rep: ModifyProtectModeResponse) => void

package/src/services/cdb/v20170320/cdb_models.ts

@@ -9366,25 +9366,37 @@ export interface CloseAuditServiceRequest {
 }
 
 /**
- * CPU弹性扩容的自动扩容策略
+ * CPU 弹性扩容的自动扩容策略。
  */
 export interface AutoStrategy {
   /**
-   * 自动扩容阈值，可选值70、80、90，代表CPU利用率达到70%、80%、90%时后台进行自动扩容
+   * 自动扩容阈值，可选值40、50、60、70、80、90，代表 CPU 利用率达到40%、50%、60%、70%、80%、90%时后台进行自动扩容。
    */
   ExpandThreshold: number
-  /**
-   * 自动扩容观测周期，单位是分钟，可选值1、3、5、10、15、30。后台会按照配置的周期进行扩容判断。
-   */
-  ExpandPeriod: number
   /**
    * 自动缩容阈值，可选值10、20、30，代表CPU利用率达到10%、20%、30%时后台进行自动缩容
    */
   ShrinkThreshold: number
+  /**
+   * 自动扩容观测周期，单位是分钟，可选值1、3、5、10、15、30。后台会按照配置的周期进行扩容判断。
+注意：此字段可能返回 null，表示取不到有效值。
+   * @deprecated
+   */
+  ExpandPeriod?: number
   /**
    * 自动缩容观测周期，单位是分钟，可选值5、10、15、30。后台会按照配置的周期进行缩容判断。
+注意：此字段可能返回 null，表示取不到有效值。
+   * @deprecated
+   */
+  ShrinkPeriod?: number
+  /**
+   * 弹性扩容观测周期（秒级）
+   */
+  ExpandSecondPeriod?: number
+  /**
+   * 缩容观测周期（秒级）
    */
-  ShrinkPeriod: number
+  ShrinkSecondPeriod?: number
 }
 
 /**

package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts

@@ -365,8 +365,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     AdjustCdbProxy(req: AdjustCdbProxyRequest, cb?: (error: string, rep: AdjustCdbProxyResponse) => void): Promise<AdjustCdbProxyResponse>;
     /**
-     * 该接口（ModifyProtectMode）用于修改实例的同步方式。
-     */
+       * 该接口（ModifyProtectMode）用于修改实例的同步方式。
+  说明：仅专属集群可调用，该接口即将下线。
+       */
     ModifyProtectMode(req: ModifyProtectModeRequest, cb?: (error: string, rep: ModifyProtectModeResponse) => void): Promise<ModifyProtectModeResponse>;
     /**
      * 本接口(UpgradeDBInstanceEngineVersion)用于升级云数据库实例版本，实例类型支持主实例、灾备实例和只读实例等。

package/tencentcloud/services/cdb/v20170320/cdb_client.js

@@ -548,8 +548,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("AdjustCdbProxy", req, cb);
     }
     /**
-     * 该接口（ModifyProtectMode）用于修改实例的同步方式。
-     */
+       * 该接口（ModifyProtectMode）用于修改实例的同步方式。
+  说明：仅专属集群可调用，该接口即将下线。
+       */
     async ModifyProtectMode(req, cb) {
         return this.request("ModifyProtectMode", req, cb);
     }

package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts

@@ -8952,25 +8952,37 @@ export interface CloseAuditServiceRequest {
     InstanceId: string;
 }
 /**
- * CPU弹性扩容的自动扩容策略
+ * CPU 弹性扩容的自动扩容策略。
  */
 export interface AutoStrategy {
     /**
-     * 自动扩容阈值，可选值70、80、90，代表CPU利用率达到70%、80%、90%时后台进行自动扩容
+     * 自动扩容阈值，可选值40、50、60、70、80、90，代表 CPU 利用率达到40%、50%、60%、70%、80%、90%时后台进行自动扩容。
      */
     ExpandThreshold: number;
-    /**
-     * 自动扩容观测周期，单位是分钟，可选值1、3、5、10、15、30。后台会按照配置的周期进行扩容判断。
-     */
-    ExpandPeriod: number;
     /**
      * 自动缩容阈值，可选值10、20、30，代表CPU利用率达到10%、20%、30%时后台进行自动缩容
      */
     ShrinkThreshold: number;
+    /**
+     * 自动扩容观测周期，单位是分钟，可选值1、3、5、10、15、30。后台会按照配置的周期进行扩容判断。
+  注意：此字段可能返回 null，表示取不到有效值。
+     * @deprecated
+     */
+    ExpandPeriod?: number;
     /**
      * 自动缩容观测周期，单位是分钟，可选值5、10、15、30。后台会按照配置的周期进行缩容判断。
+  注意：此字段可能返回 null，表示取不到有效值。
+     * @deprecated
+     */
+    ShrinkPeriod?: number;
+    /**
+     * 弹性扩容观测周期（秒级）
+     */
+    ExpandSecondPeriod?: number;
+    /**
+     * 缩容观测周期（秒级）
      */
-    ShrinkPeriod: number;
+    ShrinkSecondPeriod?: number;
 }
 /**
  * ModifyAccountMaxUserConnections返回参数结构体