tencentcloud-sdk-nodejs 4.1.64 → 4.1.65

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

@@ -24,7 +24,7 @@ export declare class Client extends AbstractClient {
      */
     DescribeTableColumns(req: DescribeTableColumnsRequest, cb?: (error: string, rep: DescribeTableColumnsResponse) => void): Promise<DescribeTableColumnsResponse>;
     /**
-     * 开启SSL连接功能。
+     * 本接口（OpenSSL）用于开启 SSL 连接功能。
      */
     OpenSSL(req: OpenSSLRequest, cb?: (error: string, rep: OpenSSLResponse) => void): Promise<OpenSSLResponse>;
     /**
@@ -132,7 +132,8 @@ export declare class Client extends AbstractClient {
      */
     ModifyBackupDownloadRestriction(req: ModifyBackupDownloadRestrictionRequest, cb?: (error: string, rep: ModifyBackupDownloadRestrictionResponse) => void): Promise<ModifyBackupDownloadRestrictionResponse>;
     /**
-     * 该接口（DescribeParamTemplates）查询参数模板列表，全地域公共参数Region均为ap-guangzhou。
+     * 该接口（DescribeParamTemplates）查询参数模板列表。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     DescribeParamTemplates(req: DescribeParamTemplatesRequest, cb?: (error: string, rep: DescribeParamTemplatesResponse) => void): Promise<DescribeParamTemplatesResponse>;
     /**
@@ -153,8 +154,9 @@ export declare class Client extends AbstractClient {
 2、开启 [KMS服务](https://console.cloud.tencent.com/kms2)；
 
 3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role)，角色名为MySQL_QCSRole，预设策略名为QcloudAccessForMySQLRole；
+4、开启加密后不允许关闭。
 
-该 API 耗时可能到10s，客户端可能超时，如果调用 API 返回 InternalError ，请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。
+该 API 耗时可能到10s，客户端可能超时，如果调用 API 返回 InternalError ，请您调用 [DescribeDBInstanceInfo](https://cloud.tencent.com/document/product/236/44160) 确认后端加密是否开通成功，调用后参数 Encryption 为 YES 表示已开通成功。
      */
     OpenDBInstanceEncryption(req: OpenDBInstanceEncryptionRequest, cb?: (error: string, rep: OpenDBInstanceEncryptionResponse) => void): Promise<OpenDBInstanceEncryptionResponse>;
     /**
@@ -211,7 +213,7 @@ export declare class Client extends AbstractClient {
      */
     DescribeTables(req: DescribeTablesRequest, cb?: (error: string, rep: DescribeTablesResponse) => void): Promise<DescribeTablesResponse>;
     /**
-     * 本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。
+     * 本接口（DescribeAccountPrivileges）用于查询云数据库账户支持的权限信息。
      */
     DescribeAccountPrivileges(req: DescribeAccountPrivilegesRequest, cb?: (error: string, rep: DescribeAccountPrivilegesResponse) => void): Promise<DescribeAccountPrivilegesResponse>;
     /**
@@ -259,7 +261,8 @@ export declare class Client extends AbstractClient {
      */
     DescribeCdbProxyInfo(req: DescribeCdbProxyInfoRequest, cb?: (error: string, rep: DescribeCdbProxyInfoResponse) => void): Promise<DescribeCdbProxyInfoResponse>;
     /**
-     * 该接口（CreateParamTemplate）用于创建参数模板，全地域公共参数 Region 均为 ap-guangzhou。
+     * 该接口（CreateParamTemplate）用于创建参数模板。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     CreateParamTemplate(req: CreateParamTemplateRequest, cb?: (error: string, rep: CreateParamTemplateResponse) => void): Promise<CreateParamTemplateResponse>;
     /**
@@ -278,7 +281,7 @@ export declare class Client extends AbstractClient {
      */
     AddTimeWindow(req: AddTimeWindowRequest, cb?: (error: string, rep: AddTimeWindowResponse) => void): Promise<AddTimeWindowResponse>;
     /**
-     * 查询实例支持代理版本和参数
+     * 本接口（DescribeProxySupportParam）用于查询实例支持代理版本和参数。
      */
     DescribeProxySupportParam(req: DescribeProxySupportParamRequest, cb?: (error: string, rep: DescribeProxySupportParamResponse) => void): Promise<DescribeProxySupportParamResponse>;
     /**
@@ -334,7 +337,8 @@ export declare class Client extends AbstractClient {
      */
     CreateDBInstance(req: CreateDBInstanceRequest, cb?: (error: string, rep: CreateDBInstanceResponse) => void): Promise<CreateDBInstanceResponse>;
     /**
-     * 该接口（ModifyParamTemplate）用于修改参数模板，全地域公共参数Region均为ap-guangzhou。
+     * 该接口（ModifyParamTemplate）用于修改参数模板。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     ModifyParamTemplate(req: ModifyParamTemplateRequest, cb?: (error: string, rep: ModifyParamTemplateResponse) => void): Promise<ModifyParamTemplateResponse>;
     /**
@@ -354,7 +358,8 @@ export declare class Client extends AbstractClient {
      */
     DescribeDeployGroupList(req: DescribeDeployGroupListRequest, cb?: (error: string, rep: DescribeDeployGroupListResponse) => void): Promise<DescribeDeployGroupListResponse>;
     /**
-     * 本接口(StopDBImportJob)用于终止数据导入任务。
+     * 本接口（StopDBImportJob）用于终止数据导入任务。
+说明：只有未完成的导入任务支持被终止，且终止后已执行的 SQL 部分会被保留。
      */
     StopDBImportJob(req: StopDBImportJobRequest, cb?: (error: string, rep: StopDBImportJobResponse) => void): Promise<StopDBImportJobResponse>;
     /**
@@ -366,7 +371,7 @@ export declare class Client extends AbstractClient {
      */
     CreateAccounts(req: CreateAccountsRequest, cb?: (error: string, rep: CreateAccountsResponse) => void): Promise<CreateAccountsResponse>;
     /**
-     * 调整数据库代理配置
+     * 本接口（AdjustCdbProxy）用于调整数据库代理配置。
      */
     AdjustCdbProxy(req: AdjustCdbProxyRequest, cb?: (error: string, rep: AdjustCdbProxyResponse) => void): Promise<AdjustCdbProxyResponse>;
     /**
@@ -423,7 +428,7 @@ export declare class Client extends AbstractClient {
      */
     DescribeRollbackRangeTime(req: DescribeRollbackRangeTimeRequest, cb?: (error: string, rep: DescribeRollbackRangeTimeResponse) => void): Promise<DescribeRollbackRangeTimeResponse>;
     /**
-     * 请求关闭数据库代理地址
+     * 本接口（CloseCdbProxyAddress）用于请求关闭数据库代理地址。
      */
     CloseCdbProxyAddress(req: CloseCdbProxyAddressRequest, cb?: (error: string, rep: CloseCdbProxyAddressResponse) => void): Promise<CloseCdbProxyAddressResponse>;
     /**
@@ -435,7 +440,7 @@ export declare class Client extends AbstractClient {
      */
     DescribeRoMinScale(req: DescribeRoMinScaleRequest, cb?: (error: string, rep: DescribeRoMinScaleResponse) => void): Promise<DescribeRoMinScaleResponse>;
     /**
-     * 修改代理地址描述信息
+     * 本接口（ModifyCdbProxyAddressDesc）用于修改代理地址描述信息。
      */
     ModifyCdbProxyAddressDesc(req: ModifyCdbProxyAddressDescRequest, cb?: (error: string, rep: ModifyCdbProxyAddressDescResponse) => void): Promise<ModifyCdbProxyAddressDescResponse>;
     /**
@@ -600,7 +605,7 @@ export declare class Client extends AbstractClient {
      */
     DescribeCpuExpandHistory(req: DescribeCpuExpandHistoryRequest, cb?: (error: string, rep: DescribeCpuExpandHistoryResponse) => void): Promise<DescribeCpuExpandHistoryResponse>;
     /**
-     * CDB实例开通审计服务
+     * 本接口（OpenAuditService）用 CDB 实例开通审计服务。
      */
     OpenAuditService(req: OpenAuditServiceRequest, cb?: (error: string, rep: OpenAuditServiceResponse) => void): Promise<OpenAuditServiceResponse>;
     /**
@@ -626,7 +631,7 @@ export declare class Client extends AbstractClient {
      */
     DescribeRemoteBackupConfig(req: DescribeRemoteBackupConfigRequest, cb?: (error: string, rep: DescribeRemoteBackupConfigResponse) => void): Promise<DescribeRemoteBackupConfigResponse>;
     /**
-     * 修改数据库代理地址VPC信息
+     * 本接口（ModifyCdbProxyAddressVipAndVPort）用于修改数据库代理地址VPC信息。
      */
     ModifyCdbProxyAddressVipAndVPort(req: ModifyCdbProxyAddressVipAndVPortRequest, cb?: (error: string, rep: ModifyCdbProxyAddressVipAndVPortResponse) => void): Promise<ModifyCdbProxyAddressVipAndVPortResponse>;
     /**
@@ -654,7 +659,7 @@ export declare class Client extends AbstractClient {
      */
     ModifyAutoRenewFlag(req: ModifyAutoRenewFlagRequest, cb?: (error: string, rep: ModifyAutoRenewFlagResponse) => void): Promise<ModifyAutoRenewFlagResponse>;
     /**
-     * 数据库代理配置变更或则升级版本后手动发起立即切换
+     * 本接口（SwitchCDBProxy）用于数据库代理配置变更或者升级版本后手动发起立即切换。
      */
     SwitchCDBProxy(req: SwitchCDBProxyRequest, cb?: (error: string, rep: SwitchCDBProxyResponse) => void): Promise<SwitchCDBProxyResponse>;
     /**
@@ -662,7 +667,7 @@ export declare class Client extends AbstractClient {
      */
     ModifyAuditService(req: ModifyAuditServiceRequest, cb?: (error: string, rep: ModifyAuditServiceResponse) => void): Promise<ModifyAuditServiceResponse>;
     /**
-     * 配置数据库代理参数
+     * 本接口（ModifyCdbProxyParam）用于配置数据库代理参数。
      */
     ModifyCdbProxyParam(req: ModifyCdbProxyParamRequest, cb?: (error: string, rep: ModifyCdbProxyParamResponse) => void): Promise<ModifyCdbProxyParamResponse>;
     /**
@@ -704,11 +709,12 @@ export declare class Client extends AbstractClient {
      */
     DescribeSupportedPrivileges(req: DescribeSupportedPrivilegesRequest, cb?: (error: string, rep: DescribeSupportedPrivilegesResponse) => void): Promise<DescribeSupportedPrivilegesResponse>;
     /**
-     * 该接口（DeleteParamTemplate）用于删除参数模板，全地域公共参数 Region 均为 ap-guangzhou。
+     * 该接口（DeleteParamTemplate）用于删除参数模板。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     DeleteParamTemplate(req: DeleteParamTemplateRequest, cb?: (error: string, rep: DeleteParamTemplateResponse) => void): Promise<DeleteParamTemplateResponse>;
     /**
-     * 升级数据库代理版本
+     * 本接口（UpgradeCDBProxyVersion）用于升级数据库代理版本。
      */
     UpgradeCDBProxyVersion(req: UpgradeCDBProxyVersionRequest, cb?: (error: string, rep: UpgradeCDBProxyVersionResponse) => void): Promise<UpgradeCDBProxyVersionResponse>;
     /**
@@ -732,11 +738,11 @@ export declare class Client extends AbstractClient {
      */
     DescribeInstanceAlarmEvents(req: DescribeInstanceAlarmEventsRequest, cb?: (error: string, rep: DescribeInstanceAlarmEventsResponse) => void): Promise<DescribeInstanceAlarmEventsResponse>;
     /**
-     * 本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。
+     * 本接口（UpgradeDBInstance）用于升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。
      */
     UpgradeDBInstance(req: UpgradeDBInstanceRequest, cb?: (error: string, rep: UpgradeDBInstanceResponse) => void): Promise<UpgradeDBInstanceResponse>;
     /**
-     * 关闭SSL连接功能。
+     * 本接口（CloseSSL）用于关闭 SSL 连接功能。
      */
     CloseSSL(req: CloseSSLRequest, cb?: (error: string, rep: CloseSSLResponse) => void): Promise<CloseSSLResponse>;
     /**

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

@@ -52,7 +52,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeTableColumns", req, cb);
     }
     /**
-     * 开启SSL连接功能。
+     * 本接口（OpenSSL）用于开启 SSL 连接功能。
      */
     async OpenSSL(req, cb) {
         return this.request("OpenSSL", req, cb);
@@ -210,7 +210,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ModifyBackupDownloadRestriction", req, cb);
     }
     /**
-     * 该接口（DescribeParamTemplates）查询参数模板列表，全地域公共参数Region均为ap-guangzhou。
+     * 该接口（DescribeParamTemplates）查询参数模板列表。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     async DescribeParamTemplates(req, cb) {
         return this.request("DescribeParamTemplates", req, cb);
@@ -237,8 +238,9 @@ class Client extends abstract_client_1.AbstractClient {
 2、开启 [KMS服务](https://console.cloud.tencent.com/kms2)；
 
 3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role)，角色名为MySQL_QCSRole，预设策略名为QcloudAccessForMySQLRole；
+4、开启加密后不允许关闭。
 
-该 API 耗时可能到10s，客户端可能超时，如果调用 API 返回 InternalError ，请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。
+该 API 耗时可能到10s，客户端可能超时，如果调用 API 返回 InternalError ，请您调用 [DescribeDBInstanceInfo](https://cloud.tencent.com/document/product/236/44160) 确认后端加密是否开通成功，调用后参数 Encryption 为 YES 表示已开通成功。
      */
     async OpenDBInstanceEncryption(req, cb) {
         return this.request("OpenDBInstanceEncryption", req, cb);
@@ -323,7 +325,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeTables", req, cb);
     }
     /**
-     * 本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。
+     * 本接口（DescribeAccountPrivileges）用于查询云数据库账户支持的权限信息。
      */
     async DescribeAccountPrivileges(req, cb) {
         return this.request("DescribeAccountPrivileges", req, cb);
@@ -395,7 +397,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeCdbProxyInfo", req, cb);
     }
     /**
-     * 该接口（CreateParamTemplate）用于创建参数模板，全地域公共参数 Region 均为 ap-guangzhou。
+     * 该接口（CreateParamTemplate）用于创建参数模板。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     async CreateParamTemplate(req, cb) {
         return this.request("CreateParamTemplate", req, cb);
@@ -420,7 +423,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("AddTimeWindow", req, cb);
     }
     /**
-     * 查询实例支持代理版本和参数
+     * 本接口（DescribeProxySupportParam）用于查询实例支持代理版本和参数。
      */
     async DescribeProxySupportParam(req, cb) {
         return this.request("DescribeProxySupportParam", req, cb);
@@ -500,7 +503,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateDBInstance", req, cb);
     }
     /**
-     * 该接口（ModifyParamTemplate）用于修改参数模板，全地域公共参数Region均为ap-guangzhou。
+     * 该接口（ModifyParamTemplate）用于修改参数模板。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     async ModifyParamTemplate(req, cb) {
         return this.request("ModifyParamTemplate", req, cb);
@@ -530,7 +534,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeDeployGroupList", req, cb);
     }
     /**
-     * 本接口(StopDBImportJob)用于终止数据导入任务。
+     * 本接口（StopDBImportJob）用于终止数据导入任务。
+说明：只有未完成的导入任务支持被终止，且终止后已执行的 SQL 部分会被保留。
      */
     async StopDBImportJob(req, cb) {
         return this.request("StopDBImportJob", req, cb);
@@ -548,7 +553,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateAccounts", req, cb);
     }
     /**
-     * 调整数据库代理配置
+     * 本接口（AdjustCdbProxy）用于调整数据库代理配置。
      */
     async AdjustCdbProxy(req, cb) {
         return this.request("AdjustCdbProxy", req, cb);
@@ -633,7 +638,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeRollbackRangeTime", req, cb);
     }
     /**
-     * 请求关闭数据库代理地址
+     * 本接口（CloseCdbProxyAddress）用于请求关闭数据库代理地址。
      */
     async CloseCdbProxyAddress(req, cb) {
         return this.request("CloseCdbProxyAddress", req, cb);
@@ -651,7 +656,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeRoMinScale", req, cb);
     }
     /**
-     * 修改代理地址描述信息
+     * 本接口（ModifyCdbProxyAddressDesc）用于修改代理地址描述信息。
      */
     async ModifyCdbProxyAddressDesc(req, cb) {
         return this.request("ModifyCdbProxyAddressDesc", req, cb);
@@ -894,7 +899,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeCpuExpandHistory", req, cb);
     }
     /**
-     * CDB实例开通审计服务
+     * 本接口（OpenAuditService）用 CDB 实例开通审计服务。
      */
     async OpenAuditService(req, cb) {
         return this.request("OpenAuditService", req, cb);
@@ -932,7 +937,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeRemoteBackupConfig", req, cb);
     }
     /**
-     * 修改数据库代理地址VPC信息
+     * 本接口（ModifyCdbProxyAddressVipAndVPort）用于修改数据库代理地址VPC信息。
      */
     async ModifyCdbProxyAddressVipAndVPort(req, cb) {
         return this.request("ModifyCdbProxyAddressVipAndVPort", req, cb);
@@ -974,7 +979,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ModifyAutoRenewFlag", req, cb);
     }
     /**
-     * 数据库代理配置变更或则升级版本后手动发起立即切换
+     * 本接口（SwitchCDBProxy）用于数据库代理配置变更或者升级版本后手动发起立即切换。
      */
     async SwitchCDBProxy(req, cb) {
         return this.request("SwitchCDBProxy", req, cb);
@@ -986,7 +991,7 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ModifyAuditService", req, cb);
     }
     /**
-     * 配置数据库代理参数
+     * 本接口（ModifyCdbProxyParam）用于配置数据库代理参数。
      */
     async ModifyCdbProxyParam(req, cb) {
         return this.request("ModifyCdbProxyParam", req, cb);
@@ -1046,13 +1051,14 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeSupportedPrivileges", req, cb);
     }
     /**
-     * 该接口（DeleteParamTemplate）用于删除参数模板，全地域公共参数 Region 均为 ap-guangzhou。
+     * 该接口（DeleteParamTemplate）用于删除参数模板。
+说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
      */
     async DeleteParamTemplate(req, cb) {
         return this.request("DeleteParamTemplate", req, cb);
     }
     /**
-     * 升级数据库代理版本
+     * 本接口（UpgradeCDBProxyVersion）用于升级数据库代理版本。
      */
     async UpgradeCDBProxyVersion(req, cb) {
         return this.request("UpgradeCDBProxyVersion", req, cb);
@@ -1088,13 +1094,13 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeInstanceAlarmEvents", req, cb);
     }
     /**
-     * 本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。
+     * 本接口（UpgradeDBInstance）用于升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。
      */
     async UpgradeDBInstance(req, cb) {
         return this.request("UpgradeDBInstance", req, cb);
     }
     /**
-     * 关闭SSL连接功能。
+     * 本接口（CloseSSL）用于关闭 SSL 连接功能。
      */
     async CloseSSL(req, cb) {
         return this.request("CloseSSL", req, cb);