npm - tencentcloud-sdk-nodejs-tcb - Versions diffs - 4.1.191 → 4.1.193 - Mend

tencentcloud-sdk-nodejs-tcb 4.1.191 → 4.1.193

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-tcb",
-  "version": "4.1.191",
+  "version": "4.1.193",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts CHANGED Viewed

@@ -8,7 +8,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
     constructor(clientConfig: TencentCloudCommon.ClientConfig);
     /**
        * 查询开通Mysql结果，`Response.Data.Status = "notexist"` 表示未开通，如果未开通，可以调用 [CreateMySQL](https://cloud.tencent.com/document/api/876/128186) 来开通
-   `Response.Data. Status = "success"` 表示开通成功，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)
+   `Response.Data. Status = "success"` 表示开通成功，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令
        */
     DescribeCreateMySQLResult(req: DescribeCreateMySQLResultRequest, cb?: (error: string, rep: DescribeCreateMySQLResultResponse) => void): Promise<DescribeCreateMySQLResultResponse>;
     /**
@@ -24,13 +24,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateHostingDomain(req: CreateHostingDomainRequest, cb?: (error: string, rep: CreateHostingDomainResponse) => void): Promise<CreateHostingDomainResponse>;
     /**
-       * 开通Mysql
+       * 开通Mysql型数据库
-  开通后，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询开通结果
+  开通后，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询开通结果，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令
        */
     CreateMySQL(req: CreateMySQLRequest, cb?: (error: string, rep: CreateMySQLResponse) => void): Promise<CreateMySQLResponse>;
     /**
-     * 本接口(CreateTable)用于创建表，支持创建capped类型集合，暂时不支持分片表
+     * 本接口(CreateTable)用于创建文档型数据库表，支持创建capped类型集合，暂时不支持分片表
      */
     CreateTable(req: CreateTableRequest, cb?: (error: string, rep: CreateTableResponse) => void): Promise<CreateTableResponse>;
     /**
@@ -46,11 +46,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     CreateEnv(req: CreateEnvRequest, cb?: (error: string, rep: CreateEnvResponse) => void): Promise<CreateEnvResponse>;
     /**
-     * 修改数据库权限
+     * 修改文档型数据库权限
      */
     ModifyDatabaseACL(req: ModifyDatabaseACLRequest, cb?: (error: string, rep: ModifyDatabaseACLResponse) => void): Promise<ModifyDatabaseACLResponse>;
     /**
-     * 本接口用于执行数据库命令
+     * 本接口用于执行文档型数据库命令
      */
     RunCommands(req: RunCommandsRequest, cb?: (error: string, rep: RunCommandsResponse) => void): Promise<RunCommandsResponse>;
     /**
@@ -93,7 +93,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 查询Mysql集群信息
-  调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息
+  调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令
        */
     DescribeMySQLClusterDetail(req: DescribeMySQLClusterDetailRequest, cb?: (error: string, rep: DescribeMySQLClusterDetailResponse) => void): Promise<DescribeMySQLClusterDetailResponse>;
     /**
@@ -115,7 +115,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     ReinstateEnv(req: ReinstateEnvRequest, cb?: (error: string, rep: ReinstateEnvResponse) => void): Promise<ReinstateEnvResponse>;
     /**
-     * 获取数据库权限
+     * 获取文档型数据库权限
      */
     DescribeDatabaseACL(req: DescribeDatabaseACLRequest, cb?: (error: string, rep: DescribeDatabaseACLResponse) => void): Promise<DescribeDatabaseACLResponse>;
     /**
@@ -127,11 +127,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     DescribeStaticStore(req: DescribeStaticStoreRequest, cb?: (error: string, rep: DescribeStaticStoreResponse) => void): Promise<DescribeStaticStoreResponse>;
     /**
-     * 查询表的相关信息，包括索引等信息
-     */
+       * 查询文档型数据库表的相关信息，包括索引等信息
+  接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取
+       */
     DescribeTable(req: DescribeTableRequest, cb?: (error: string, rep: DescribeTableResponse) => void): Promise<DescribeTableResponse>;
     /**
-     * 本接口(UpdateTable)用于修改表信息，当前可以支持创建和删除索引
+     * 本接口(UpdateTable)用于修改文档型数据库表信息，当前可以支持创建和删除索引
      */
     UpdateTable(req: UpdateTableRequest, cb?: (error: string, rep: UpdateTableResponse) => void): Promise<UpdateTableResponse>;
     /**
@@ -143,8 +145,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CheckTcbService(req?: CheckTcbServiceRequest, cb?: (error: string, rep: CheckTcbServiceResponse) => void): Promise<CheckTcbServiceResponse>;
     /**
-     * 本接口(ListTables)用于查询所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
-     */
+       * 本接口(ListTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
+  该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口
+       */
     ListTables(req: ListTablesRequest, cb?: (error: string, rep: ListTablesResponse) => void): Promise<ListTablesResponse>;
     /**
        * 查询数据库安全规则。
@@ -182,14 +186,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     ModifyEnv(req: ModifyEnvRequest, cb?: (error: string, rep: ModifyEnvResponse) => void): Promise<ModifyEnvResponse>;
     /**
-       * 执行SQL语句
+       * 执行MySQL语句
+  该接口用来执行 MySql 语句，比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口
   调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作
        */
     RunSql(req: RunSqlRequest, cb?: (error: string, rep: RunSqlResponse) => void): Promise<RunSqlResponse>;
     /**
-     * 本接口(DeleteTable)用于删除表，删除表后表中数据将会被删除且无法恢复，请谨慎操作
-     */
+       * 本接口(DeleteTable)用于删除文档型数据库表，删除表后表中数据将会被删除且无法恢复，请谨慎操作
+  接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取
+       */
     DeleteTable(req: DeleteTableRequest, cb?: (error: string, rep: DeleteTableResponse) => void): Promise<DeleteTableResponse>;
     /**
        * 本接口用于销毁云开发环境。
@@ -276,7 +284,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     DescribeEnvAccountCircle(req: DescribeEnvAccountCircleRequest, cb?: (error: string, rep: DescribeEnvAccountCircleResponse) => void): Promise<DescribeEnvAccountCircleResponse>;
     /**
-     * 本接口(ListTables)用于查询所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
+     * 本接口(DescribeTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
      */
     DescribeTables(req: DescribeTablesRequest, cb?: (error: string, rep: DescribeTablesResponse) => void): Promise<DescribeTablesResponse>;
 }

package/tencentcloud/services/tcb/v20180608/tcb_client.js CHANGED Viewed

@@ -30,7 +30,7 @@ class Client extends TencentCloudCommon.AbstractClient {
     }
     /**
        * 查询开通Mysql结果，`Response.Data.Status = "notexist"` 表示未开通，如果未开通，可以调用 [CreateMySQL](https://cloud.tencent.com/document/api/876/128186) 来开通
-   `Response.Data. Status = "success"` 表示开通成功，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)
+   `Response.Data. Status = "success"` 表示开通成功，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令
        */
     async DescribeCreateMySQLResult(req, cb) {
         return this.request("DescribeCreateMySQLResult", req, cb);
@@ -54,15 +54,15 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateHostingDomain", req, cb);
     }
     /**
-       * 开通Mysql
+       * 开通Mysql型数据库
-  开通后，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询开通结果
+  开通后，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询开通结果，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令
        */
     async CreateMySQL(req, cb) {
         return this.request("CreateMySQL", req, cb);
     }
     /**
-     * 本接口(CreateTable)用于创建表，支持创建capped类型集合，暂时不支持分片表
+     * 本接口(CreateTable)用于创建文档型数据库表，支持创建capped类型集合，暂时不支持分片表
      */
     async CreateTable(req, cb) {
         return this.request("CreateTable", req, cb);
@@ -84,13 +84,13 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateEnv", req, cb);
     }
     /**
-     * 修改数据库权限
+     * 修改文档型数据库权限
      */
     async ModifyDatabaseACL(req, cb) {
         return this.request("ModifyDatabaseACL", req, cb);
     }
     /**
-     * 本接口用于执行数据库命令
+     * 本接口用于执行文档型数据库命令
      */
     async RunCommands(req, cb) {
         return this.request("RunCommands", req, cb);
@@ -147,7 +147,7 @@ class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 查询Mysql集群信息
-  调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息
+  调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有已开通的才能查到集群信息，Mysql开通成功后，可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】，连接设置相关【关闭外网、开通外网、查询集群信息】，备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】，相关功能接口文档：[TDSQL-C MySQL API文档](https://cloud.tencent.com/document/product/1003/48106)，可以通过 [RunSql](https://cloud.tencent.com/document/api/876/127880) 接口来执行 sql 命令，比如创建表格、插入数据、删除表格等 sql 命令
        */
     async DescribeMySQLClusterDetail(req, cb) {
         return this.request("DescribeMySQLClusterDetail", req, cb);
@@ -179,7 +179,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ReinstateEnv", req, cb);
     }
     /**
-     * 获取数据库权限
+     * 获取文档型数据库权限
      */
     async DescribeDatabaseACL(req, cb) {
         return this.request("DescribeDatabaseACL", req, cb);
@@ -197,13 +197,15 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeStaticStore", req, cb);
     }
     /**
-     * 查询表的相关信息，包括索引等信息
-     */
+       * 查询文档型数据库表的相关信息，包括索引等信息
+  接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取
+       */
     async DescribeTable(req, cb) {
         return this.request("DescribeTable", req, cb);
     }
     /**
-     * 本接口(UpdateTable)用于修改表信息，当前可以支持创建和删除索引
+     * 本接口(UpdateTable)用于修改文档型数据库表信息，当前可以支持创建和删除索引
      */
     async UpdateTable(req, cb) {
         return this.request("UpdateTable", req, cb);
@@ -221,8 +223,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CheckTcbService", req, cb);
     }
     /**
-     * 本接口(ListTables)用于查询所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
-     */
+       * 本接口(ListTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
+  该接口跟 [DescribeTables](https://cloud.tencent.com/document/api/876/127962) 接口功能一致，后续该接口可能会下线，请使用 [DescribeTable](https://cloud.tencent.com/document/api/876/127962)接口
+       */
     async ListTables(req, cb) {
         return this.request("ListTables", req, cb);
     }
@@ -278,7 +282,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ModifyEnv", req, cb);
     }
     /**
-       * 执行SQL语句
+       * 执行MySQL语句
+  该接口用来执行 MySql 语句，比如创建表格、插入数据、修改数据、删除字段、添加索引等可以通过sql 语句实现的都可以使用该接口
   调用该接口前需要先查询Mysql是否开通，可通过 [DescribeCreateMySQLResult ](https://cloud.tencent.com/document/api/876/128185) 查询，只有开通成功才能操作
        */
@@ -286,8 +292,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("RunSql", req, cb);
     }
     /**
-     * 本接口(DeleteTable)用于删除表，删除表后表中数据将会被删除且无法恢复，请谨慎操作
-     */
+       * 本接口(DeleteTable)用于删除文档型数据库表，删除表后表中数据将会被删除且无法恢复，请谨慎操作
+  接口入参中的 Tag 为文档型数据库的实例 Id，可以通过 [DescribeEnvs](https://cloud.tencent.com/document/api/876/34820) 接口返回的 EnvList[0].Databases[0].InstanceId 获取
+       */
     async DeleteTable(req, cb) {
         return this.request("DeleteTable", req, cb);
     }
@@ -404,7 +412,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeEnvAccountCircle", req, cb);
     }
     /**
-     * 本接口(ListTables)用于查询所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
+     * 本接口(DescribeTables)用于查询文档型数据库所有表信息，包括表名、表中数据条数、表中数据量、索引个数及索引的大小等
      */
     async DescribeTables(req, cb) {
         return this.request("DescribeTables", req, cb);

package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts CHANGED Viewed

@@ -1965,6 +1965,10 @@ export interface DescribeTablesRequest {
      * MongoConnector
      */
     MongoConnector?: MongoConnector;
+    /**
+     * 指定表名过滤，为空时返回所有表
+     */
+    TableNames?: Array<string>;
 }
 /**
  * DescribeUserList请求参数结构体
@@ -2400,7 +2404,7 @@ export interface DescribeHostingDomainTaskResponse {
     /**
      * todo/doing/done/error
      */
-    Status: string;
+    Status?: string;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */