tencentcloud-sdk-nodejs-ssl 4.0.1027 → 4.0.1028

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-ssl",
-  "version": "4.0.1027",
+  "version": "4.0.1028",
   "description": "Tencent Cloud API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

package/src/services/ssl/v20191205/ssl_models.ts

@@ -804,7 +804,7 @@ export interface CdnInstanceDetail {
    */
   CertId?: string
   /**
-   * 域名状态
+   * 域名状态 rejected：域名审核未通过，域名备案过期/被注销导致，processing：部署中，online：已启动，offline：已关闭
    */
   Status?: string
   /**
@@ -2437,7 +2437,7 @@ export interface DescribeHostVodInstanceListRequest {
    */
   IsCache?: number
   /**
-   * 过滤参数列表
+   * 过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配
    */
   Filters?: Array<Filter>
   /**
@@ -3039,6 +3039,11 @@ export interface TeoInstanceDetail {
   ZoneId?: string
   /**
    * 域名状态
+deployed：已部署；
+processing：部署中；
+applying：申请中；
+failed：申请失败；
+issued：绑定失败。
    */
   Status?: string
 }
@@ -4543,7 +4548,7 @@ export interface DescribeHostLighthouseInstanceListRequest {
    */
   IsCache?: number
   /**
-   * 过滤参数列表
+   * 过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配
    */
   Filters?: Array<Filter>
   /**
@@ -4885,28 +4890,29 @@ export interface Error {
 }
 
 /**
- * 域名验证结果
+ * 证书域名验证结果
  */
 export interface DomainValidationResult {
   /**
-   * 域名。
+   * 证书绑定的域名。
    */
   Domain?: string
   /**
-   * 验证类型。
+   * 域名验证类型。 取值为：DNS、FILE、DNS_AUTO、DNS_PROXY、FILE_PROXY
 注意：此字段可能返回 null，表示取不到有效值。
    */
   VerifyType?: string
   /**
-   * 本地检查结果。
+   * 腾讯云检测结果，取值：1（验证通过）； -1（被限频或者 txt record not found）；-2（txt record not match）；-3（ns record not found）；-4（file not found）；-5（file not match）；-6（cname record not found）；-7（cname record not match）；-8（ns record not found）-9（file not found）；-10（file not match）
+
    */
   LocalCheck?: number
   /**
-   * CA检查结果。
+   * CA检查结果。取值： -1（未检测通过）；2（检测通过）
    */
   CaCheck?: number
   /**
-   * 检查失败原因。
+   * 检查失败原因。状态LocalCheck的具体描述
 注意：此字段可能返回 null，表示取不到有效值。
    */
   LocalCheckFailReason?: string
@@ -4916,11 +4922,11 @@ export interface DomainValidationResult {
    */
   CheckValue?: Array<string>
   /**
-   * 是否频繁请求。
+   * 是否被限频拦截， 取值：false（未被限频）；true（被限频）
    */
   Frequently?: boolean
   /**
-   * 是否已经签发。
+   * 证书是否已经签发。取值： false（未签发）；true（已签发）
    */
   Issued?: boolean
 }

package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts

@@ -772,7 +772,7 @@ export interface CdnInstanceDetail {
      */
     CertId?: string;
     /**
-     * 域名状态
+     * 域名状态 rejected：域名审核未通过，域名备案过期/被注销导致，processing：部署中，online：已启动，offline：已关闭
      */
     Status?: string;
     /**
@@ -2346,7 +2346,7 @@ export interface DescribeHostVodInstanceListRequest {
      */
     IsCache?: number;
     /**
-     * 过滤参数列表
+     * 过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配
      */
     Filters?: Array<Filter>;
     /**
@@ -2923,6 +2923,11 @@ export interface TeoInstanceDetail {
     ZoneId?: string;
     /**
      * 域名状态
+  deployed：已部署；
+  processing：部署中；
+  applying：申请中；
+  failed：申请失败；
+  issued：绑定失败。
      */
     Status?: string;
 }
@@ -4371,7 +4376,7 @@ export interface DescribeHostLighthouseInstanceListRequest {
      */
     IsCache?: number;
     /**
-     * 过滤参数列表
+     * 过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配
      */
     Filters?: Array<Filter>;
     /**
@@ -4697,28 +4702,29 @@ export interface Error {
     Message?: string;
 }
 /**
- * 域名验证结果
+ * 证书域名验证结果
  */
 export interface DomainValidationResult {
     /**
-     * 域名。
+     * 证书绑定的域名。
      */
     Domain?: string;
     /**
-     * 验证类型。
+     * 域名验证类型。 取值为：DNS、FILE、DNS_AUTO、DNS_PROXY、FILE_PROXY
   注意：此字段可能返回 null，表示取不到有效值。
      */
     VerifyType?: string;
     /**
-     * 本地检查结果。
+     * 腾讯云检测结果，取值：1（验证通过）； -1（被限频或者 txt record not found）；-2（txt record not match）；-3（ns record not found）；-4（file not found）；-5（file not match）；-6（cname record not found）；-7（cname record not match）；-8（ns record not found）-9（file not found）；-10（file not match）
+  
      */
     LocalCheck?: number;
     /**
-     * CA检查结果。
+     * CA检查结果。取值： -1（未检测通过）；2（检测通过）
      */
     CaCheck?: number;
     /**
-     * 检查失败原因。
+     * 检查失败原因。状态LocalCheck的具体描述
   注意：此字段可能返回 null，表示取不到有效值。
      */
     LocalCheckFailReason?: string;
@@ -4728,11 +4734,11 @@ export interface DomainValidationResult {
      */
     CheckValue?: Array<string>;
     /**
-     * 是否频繁请求。
+     * 是否被限频拦截， 取值：false（未被限频）；true（被限频）
      */
     Frequently?: boolean;
     /**
-     * 是否已经签发。
+     * 证书是否已经签发。取值： false（未签发）；true（已签发）
      */
     Issued?: boolean;
 }