tencentcloud-sdk-nodejs 4.0.788 → 4.0.790

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 (82) hide show
  1. package/CHANGELOG.md +533 -0
  2. package/README.md +6 -0
  3. package/SERVICE_CHANGELOG.md +1106 -204
  4. package/examples/cls/v20201016/cls.proto +34 -0
  5. package/examples/cls/v20201016/upload_log.js +69 -0
  6. package/package.json +1 -1
  7. package/products.md +19 -18
  8. package/src/common/abstract_client.ts +32 -0
  9. package/src/common/http/http_connection.ts +5 -2
  10. package/src/common/sdk_version.ts +1 -1
  11. package/src/common/sign.ts +8 -4
  12. package/src/services/apigateway/v20180808/apigateway_models.ts +1 -1
  13. package/src/services/cdb/v20170320/cdb_client.ts +18 -6
  14. package/src/services/cdb/v20170320/cdb_models.ts +15 -0
  15. package/src/services/emr/v20190103/emr_models.ts +41 -36
  16. package/src/services/ess/v20201111/ess_client.ts +22 -4
  17. package/src/services/ess/v20201111/ess_models.ts +19 -10
  18. package/src/services/essbasic/v20210526/essbasic_client.ts +11 -9
  19. package/src/services/essbasic/v20210526/essbasic_models.ts +4 -0
  20. package/src/services/index.ts +1 -0
  21. package/src/services/iotvideo/v20211125/iotvideo_models.ts +8 -0
  22. package/src/services/mna/v20210119/mna_models.ts +3 -3
  23. package/src/services/mongodb/v20190725/mongodb_models.ts +5 -0
  24. package/src/services/monitor/v20180724/monitor_models.ts +2 -4
  25. package/src/services/redis/v20180412/redis_models.ts +25 -11
  26. package/src/services/rum/v20210622/rum_models.ts +2 -1
  27. package/src/services/ssl/v20191205/ssl_models.ts +11 -3
  28. package/src/services/svp/index.ts +5 -0
  29. package/src/services/svp/v20240125/index.ts +6 -0
  30. package/src/services/svp/v20240125/svp_client.ts +40 -0
  31. package/src/services/svp/v20240125/svp_models.ts +72 -0
  32. package/src/services/teo/v20220901/teo_client.ts +52 -33
  33. package/src/services/teo/v20220901/teo_models.ts +180 -81
  34. package/src/services/tmt/v20180321/tmt_models.ts +2 -2
  35. package/src/services/wedata/v20210820/wedata_client.ts +2802 -5338
  36. package/src/services/wedata/v20210820/wedata_models.ts +14500 -29440
  37. package/tencentcloud/common/abstract_client.d.ts +4 -0
  38. package/tencentcloud/common/abstract_client.js +22 -0
  39. package/tencentcloud/common/http/http_connection.js +6 -2
  40. package/tencentcloud/common/sdk_version.d.ts +1 -1
  41. package/tencentcloud/common/sdk_version.js +1 -1
  42. package/tencentcloud/common/sign.d.ts +2 -1
  43. package/tencentcloud/common/sign.js +6 -4
  44. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +1 -1
  45. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +7 -3
  46. package/tencentcloud/services/cdb/v20170320/cdb_client.js +9 -3
  47. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +13 -0
  48. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +41 -36
  49. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +22 -4
  50. package/tencentcloud/services/ess/v20201111/ess_client.js +22 -4
  51. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -10
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -9
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -9
  54. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -0
  55. package/tencentcloud/services/index.d.ts +1 -0
  56. package/tencentcloud/services/index.js +2 -0
  57. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +8 -0
  58. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +3 -3
  59. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +5 -0
  60. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -4
  61. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +25 -11
  62. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +2 -1
  63. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +11 -3
  64. package/tencentcloud/services/svp/index.d.ts +6 -0
  65. package/tencentcloud/services/svp/index.js +7 -0
  66. package/tencentcloud/services/svp/v20240125/index.d.ts +6 -0
  67. package/tencentcloud/services/svp/v20240125/index.js +9 -0
  68. package/tencentcloud/services/svp/v20240125/svp_client.d.ts +14 -0
  69. package/tencentcloud/services/svp/v20240125/svp_client.js +37 -0
  70. package/tencentcloud/services/svp/v20240125/svp_models.d.ts +54 -0
  71. package/tencentcloud/services/svp/v20240125/svp_models.js +18 -0
  72. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +24 -15
  73. package/tencentcloud/services/teo/v20220901/teo_client.js +27 -16
  74. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +176 -81
  75. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +2 -2
  76. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +675 -1483
  77. package/tencentcloud/services/wedata/v20210820/wedata_client.js +1027 -2237
  78. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14275 -28693
  79. package/test/cdb.v20170320.test.js +12 -2
  80. package/test/svp.v20240125.test.js +31 -0
  81. package/test/teo.v20220901.test.js +14 -4
  82. package/test/wedata.v20210820.test.js +636 -2646
@@ -33,6 +33,10 @@ export declare class AbstractClient {
33
33
  * @inner
34
34
  */
35
35
  request(action: string, req: any, options?: ResponseCallback | RequestOptions, cb?: ResponseCallback): Promise<ResponseData>;
36
+ /**
37
+ * @inner
38
+ */
39
+ requestOctetStream(action: string, req: any, options?: ResponseCallback | RequestOptions, cb?: ResponseCallback): Promise<any>;
36
40
  /**
37
41
  * @inner
38
42
  */
@@ -83,6 +83,28 @@ class AbstractClient {
83
83
  throw e;
84
84
  }
85
85
  }
86
+ /**
87
+ * @inner
88
+ */
89
+ async requestOctetStream(action, req, options, cb) {
90
+ if (typeof options === "function") {
91
+ cb = options;
92
+ options = {};
93
+ }
94
+ try {
95
+ const result = await this.doRequest(action, req !== null && req !== void 0 ? req : {}, Object.assign({}, options, {
96
+ headers: {
97
+ "Content-Type": "application/octet-stream; charset=utf-8",
98
+ },
99
+ }));
100
+ cb && cb(null, result);
101
+ return result;
102
+ }
103
+ catch (e) {
104
+ cb && cb(e, null);
105
+ throw e;
106
+ }
107
+ }
86
108
  /**
87
109
  * @inner
88
110
  */
@@ -80,8 +80,11 @@ class HttpConnection {
80
80
  config.headers["Content-Type"] = "application/x-www-form-urlencoded";
81
81
  }
82
82
  if (method === "POST" && !multipart) {
83
- config.body = JSONbigNative.stringify(data);
84
- config.headers["Content-Type"] = "application/json";
83
+ config.body = data;
84
+ const contentType = config.headers["Content-Type"] || "application/json";
85
+ if (!isBuffer(data))
86
+ config.body = JSONbigNative.stringify(data);
87
+ config.headers["Content-Type"] = contentType;
85
88
  }
86
89
  if (method === "POST" && multipart) {
87
90
  form = new FormData();
@@ -101,6 +104,7 @@ class HttpConnection {
101
104
  secretKey,
102
105
  multipart,
103
106
  boundary: form ? form.getBoundary() : undefined,
107
+ headers: config.headers,
104
108
  });
105
109
  config.headers["Authorization"] = signature;
106
110
  return await fetch_1.default(url, config);
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.788";
1
+ export declare const sdkVersion = "4.0.790";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.788";
4
+ exports.sdkVersion = "4.0.790";
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export default class Sign {
5
5
  static sign(secretKey: string, signStr: string, signMethod: string): string;
6
- static sign3({ method, url, payload, timestamp, service, secretId, secretKey, multipart, boundary, }: {
6
+ static sign3({ method, url, payload, timestamp, service, secretId, secretKey, multipart, boundary, headers: configHeaders, }: {
7
7
  method?: string;
8
8
  url?: string;
9
9
  payload: any;
@@ -13,5 +13,6 @@ export default class Sign {
13
13
  secretKey: string;
14
14
  multipart: boolean;
15
15
  boundary: string;
16
+ headers: Record<string, string>;
16
17
  }): string;
17
18
  }
@@ -20,14 +20,15 @@ class Sign {
20
20
  const hmac = crypto.createHmac(signMethodMap[signMethod], secretKey || "");
21
21
  return hmac.update(Buffer.from(signStr, "utf8")).digest("base64");
22
22
  }
23
- static sign3({ method = "POST", url = "", payload, timestamp, service, secretId, secretKey, multipart, boundary, }) {
23
+ static sign3({ method = "POST", url = "", payload, timestamp, service, secretId, secretKey, multipart, boundary, headers: configHeaders = {}, }) {
24
24
  const urlObj = new url_1.URL(url);
25
+ const contentType = configHeaders["Content-Type"];
25
26
  // 通用头部
26
27
  let headers = "";
27
28
  let signedHeaders = "";
28
29
  if (method === "GET") {
29
30
  signedHeaders = "content-type";
30
- headers = "content-type:application/x-www-form-urlencoded\n";
31
+ headers = `content-type:${contentType}\n`;
31
32
  }
32
33
  else if (method === "POST") {
33
34
  signedHeaders = "content-type";
@@ -35,7 +36,7 @@ class Sign {
35
36
  headers = `content-type:multipart/form-data; boundary=${boundary}\n`;
36
37
  }
37
38
  else {
38
- headers = "content-type:application/json\n";
39
+ headers = `content-type:${contentType}\n`;
39
40
  }
40
41
  }
41
42
  headers += `host:${urlObj.hostname}\n`;
@@ -63,7 +64,8 @@ class Sign {
63
64
  payload_hash = hash.digest("hex");
64
65
  }
65
66
  else {
66
- payload_hash = payload ? getHash(JSONbigNative.stringify(payload)) : getHash("");
67
+ const hashMessage = Buffer.isBuffer(payload) ? payload : JSONbigNative.stringify(payload);
68
+ payload_hash = payload ? getHash(hashMessage) : getHash("");
67
69
  }
68
70
  const canonicalRequest = method +
69
71
  "\n" +
@@ -3236,7 +3236,7 @@ export interface ModifyApiRequest {
3236
3236
  */
3237
3237
  ServiceTimeout?: number;
3238
3238
  /**
3239
- * API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS
3239
+ * API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
3240
3240
  */
3241
3241
  Protocol?: string;
3242
3242
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateDBImportJobRequest, DescribeDatabasesRequest, CreateCdbProxyRequest, CreateCdbProxyResponse, DescribeTablesResponse, ModifyBackupDownloadRestrictionResponse, ModifyTimeWindowResponse, ModifyTimeWindowRequest, DescribeRollbackRangeTimeRequest, DescribeBackupOverviewRequest, DescribeAuditInstanceListResponse, ModifyDBInstanceProjectResponse, DescribeDataBackupOverviewResponse, DeleteAuditPolicyRequest, CreateDatabaseRequest, ModifyInstanceParamRequest, CreateParamTemplateRequest, DescribeParamTemplateInfoRequest, ModifyCdbProxyAddressVipAndVPortResponse, DescribeDBInstancesRequest, ModifyCdbProxyAddressDescRequest, DescribeRoGroupsRequest, DescribeBackupDecryptionKeyRequest, CreateCdbProxyAddressResponse, CloseWanServiceRequest, DescribeAuditConfigRequest, CreateRoInstanceIpResponse, CreateAuditPolicyResponse, DescribeInstanceParamRecordsRequest, StopRollbackResponse, CreateCdbProxyAddressRequest, AnalyzeAuditLogsRequest, ModifyBackupEncryptionStatusResponse, DescribeInstanceParamsRequest, DescribeUploadedFilesRequest, StopDBImportJobResponse, StopCpuExpandRequest, ModifyDBInstanceNameRequest, ModifyAuditRuleResponse, DescribeAuditRulesRequest, UpgradeDBInstanceEngineVersionResponse, AssociateSecurityGroupsResponse, DescribeCdbZoneConfigResponse, DescribeTablesRequest, UpgradeDBInstanceRequest, ModifyParamTemplateRequest, OpenAuditServiceResponse, DescribeBinlogBackupOverviewResponse, DescribeDBInstanceLogToCLSResponse, SwitchDBInstanceMasterSlaveRequest, ModifyCdbProxyAddressVipAndVPortRequest, ModifyAutoRenewFlagRequest, DeleteDeployGroupsRequest, DescribeAuditConfigResponse, ModifyBackupConfigResponse, DescribeTimeWindowResponse, DeleteAuditPolicyResponse, InitDBInstancesResponse, DescribeParamTemplateInfoResponse, DescribeInstanceParamsResponse, DeleteDatabaseRequest, DisassociateSecurityGroupsRequest, ModifyLocalBinlogConfigRequest, StartBatchRollbackResponse, ModifyAccountHostResponse, DescribeRollbackRangeTimeResponse, ModifyRoGroupInfoRequest, CreateAuditLogFileRequest, DescribeBinlogsRequest, DescribeCdbProxyInfoRequest, ModifyAuditRuleTemplatesRequest, CreateAuditRuleResponse, ModifyRemoteBackupConfigResponse, DescribeDBInstanceInfoResponse, AssociateSecurityGroupsRequest, StartReplicationResponse, DescribeDBFeaturesResponse, ModifyAuditRuleRequest, DescribeBinlogsResponse, DescribeRoMinScaleRequest, DescribeDefaultParamsRequest, SwitchDBInstanceMasterSlaveResponse, DescribeBackupsRequest, DescribeInstanceParamRecordsResponse, DescribeDBInstanceGTIDResponse, DeleteParamTemplateRequest, ModifyBackupDownloadRestrictionRequest, CreateParamTemplateResponse, ModifyAccountPasswordResponse, ReleaseIsolatedDBInstancesRequest, CreateDatabaseResponse, DescribeErrorLogDataResponse, AddTimeWindowRequest, DeleteAuditLogFileResponse, DescribeDBSecurityGroupsRequest, DescribeDBSwitchRecordsResponse, CreateAuditLogFileResponse, ModifyCdbProxyParamResponse, ModifyInstanceTagResponse, DescribeDBSwitchRecordsRequest, DescribeSupportedPrivilegesRequest, DescribeAsyncRequestInfoResponse, DeleteAccountsResponse, ModifyCdbProxyAddressDescResponse, ModifyDBInstanceLogToCLSRequest, DeleteTimeWindowResponse, DescribeBackupsResponse, CreateAuditPolicyRequest, CreateRoInstanceIpRequest, OpenWanServiceRequest, StopCpuExpandResponse, DescribeBackupConfigResponse, DescribeParamTemplatesResponse, DescribeProjectSecurityGroupsRequest, StopReplicationRequest, StartCpuExpandResponse, CreateCloneInstanceResponse, DescribeCdbZoneConfigRequest, DescribeAsyncRequestInfoRequest, BalanceRoGroupLoadRequest, DescribeBackupOverviewResponse, DescribeLocalBinlogConfigRequest, DescribeDeviceMonitorInfoRequest, StopDBImportJobRequest, DescribeDBPriceRequest, ModifyAccountPrivilegesResponse, StopRollbackRequest, ResetRootAccountRequest, DescribeDBInstanceConfigRequest, ModifyAuditServiceRequest, DescribeProxyCustomConfResponse, ModifyAuditConfigResponse, SwitchDrInstanceToMasterResponse, ModifyDBInstanceNameResponse, VerifyRootAccountRequest, DescribeCloneListResponse, DescribeDBInstanceLogToCLSRequest, DescribeDBInstanceConfigResponse, StartBatchRollbackRequest, OpenDBInstanceEncryptionRequest, DescribeDBInstanceCharsetRequest, ModifyInstancePasswordComplexityResponse, DescribeRemoteBackupConfigRequest, DescribeDBInstancesResponse, DescribeBackupDownloadRestrictionRequest, CreateDeployGroupRequest, DeleteAccountsRequest, ReloadBalanceProxyNodeRequest, DescribeAccountsResponse, DescribeAuditRuleTemplateModifyHistoryResponse, DescribeAuditLogFilesRequest, ModifyBackupConfigRequest, DisassociateSecurityGroupsResponse, InquiryPriceUpgradeInstancesResponse, CreateDBInstanceRequest, DescribeParamTemplatesRequest, DescribeAccountPrivilegesResponse, DescribeAuditLogsRequest, DescribeBackupConfigRequest, DescribeAccountsRequest, DescribeErrorLogDataRequest, DescribeAuditLogFilesResponse, DescribeDBInstanceRebootTimeRequest, CreateAccountsResponse, CreateDeployGroupResponse, ResetRootAccountResponse, ModifyNameOrDescByDpIdResponse, DescribeDBPriceResponse, OpenDBInstanceGTIDResponse, VerifyRootAccountResponse, DescribeDBInstanceRebootTimeResponse, SwitchDrInstanceToMasterRequest, ModifyCdbProxyParamRequest, SwitchForUpgradeRequest, CreateDBInstanceHourResponse, DescribeBackupDownloadRestrictionResponse, ModifyDBInstanceSecurityGroupsResponse, CreateAccountsRequest, DeleteAuditRuleTemplatesRequest, CreateAuditRuleTemplateResponse, DescribeDeployGroupListRequest, CloseWanServiceResponse, RenewDBInstanceRequest, ModifyLocalBinlogConfigResponse, DeleteDatabaseResponse, DescribeCloneListRequest, ModifyInstanceTagRequest, DescribeProxySupportParamRequest, ModifyAutoRenewFlagResponse, StartReplicationRequest, ReloadBalanceProxyNodeResponse, DescribeRemoteBackupConfigResponse, DescribeDBImportRecordsResponse, DescribeProxySupportParamResponse, CloseAuditServiceResponse, DescribeRollbackTaskDetailRequest, AdjustCdbProxyResponse, ModifyParamTemplateResponse, BalanceRoGroupLoadResponse, ModifyDBInstanceVipVportResponse, DeleteAuditRuleResponse, IsolateDBInstanceRequest, DescribeDefaultParamsResponse, SwitchCDBProxyRequest, DescribeTagsOfInstanceIdsResponse, DescribeDeployGroupListResponse, OfflineIsolatedInstancesResponse, CreateAuditRuleTemplateRequest, DescribeAuditPoliciesRequest, AdjustCdbProxyAddressRequest, DescribeDatabasesResponse, DescribeRoGroupsResponse, CloseCdbProxyAddressResponse, DescribeAuditRulesResponse, ModifyAccountHostRequest, CreateAuditRuleRequest, ModifyAccountPrivilegesRequest, CreateBackupRequest, DescribeTimeWindowRequest, AdjustCdbProxyAddressResponse, ModifyDBInstanceVipVportRequest, DescribeDBImportRecordsRequest, CreateDBImportJobResponse, DescribeTagsOfInstanceIdsRequest, StartCpuExpandRequest, DescribeCpuExpandStrategyRequest, CloseCDBProxyResponse, StopReplicationResponse, UpgradeDBInstanceEngineVersionRequest, DescribeDataBackupOverviewRequest, DescribeDBInstanceInfoRequest, ModifyDBInstanceProjectRequest, SwitchForUpgradeResponse, DescribeAccountPrivilegesRequest, DescribeSupportedPrivilegesResponse, DescribeLocalBinlogConfigResponse, ModifyAuditServiceResponse, ModifyInstancePasswordComplexityRequest, OpenWanServiceResponse, DescribeDBInstanceGTIDRequest, DescribeBackupEncryptionStatusResponse, DescribeCdbProxyInfoResponse, ModifyAuditConfigRequest, DescribeRoMinScaleResponse, DescribeSlowLogDataResponse, RestartDBInstancesResponse, DescribeSlowLogsRequest, DescribeProxyCustomConfRequest, DescribeDBSecurityGroupsResponse, CloseCdbProxyAddressRequest, ModifyRoGroupInfoResponse, DeleteAuditRuleRequest, DeleteParamTemplateResponse, DescribeAuditRuleTemplateModifyHistoryRequest, DescribeTasksResponse, DescribeAuditLogsResponse, DescribeAuditPoliciesResponse, IsolateDBInstanceResponse, AdjustCdbProxyRequest, ModifyAccountDescriptionResponse, ModifyAccountMaxUserConnectionsRequest, DeleteDeployGroupsResponse, DescribeTasksRequest, ModifyBackupEncryptionStatusRequest, DescribeRollbackTaskDetailResponse, CreateDBInstanceHourRequest, DescribeAuditRuleTemplatesResponse, CreateCloneInstanceRequest, CloseCDBProxyRequest, DeleteBackupResponse, DescribeProjectSecurityGroupsResponse, DescribeBackupSummariesRequest, AnalyzeAuditLogsResponse, CreateDBInstanceResponse, OpenAuditServiceRequest, DescribeDBInstanceCharsetResponse, DescribeDBFeaturesRequest, DescribeBackupSummariesResponse, DescribeBinlogBackupOverviewRequest, ModifyDBInstanceSecurityGroupsRequest, CloseAuditServiceRequest, ModifyAccountMaxUserConnectionsResponse, DescribeBackupDecryptionKeyResponse, OfflineIsolatedInstancesRequest, InquiryPriceUpgradeInstancesRequest, ModifyInstanceParamResponse, DescribeUploadedFilesResponse, InitDBInstancesRequest, CreateBackupResponse, OpenDBInstanceGTIDRequest, OpenDBInstanceEncryptionResponse, UpgradeCDBProxyVersionResponse, ModifyAccountDescriptionRequest, ModifyAccountPasswordRequest, DescribeCpuExpandStrategyResponse, RenewDBInstanceResponse, AddTimeWindowResponse, DescribeAuditInstanceListRequest, DescribeBackupEncryptionStatusRequest, ModifyDBInstanceLogToCLSResponse, DescribeAuditRuleTemplatesRequest, DescribeSlowLogDataRequest, ReleaseIsolatedDBInstancesResponse, DeleteAuditLogFileRequest, DescribeSlowLogsResponse, DeleteTimeWindowRequest, SwitchCDBProxyResponse, RestartDBInstancesRequest, ModifyRemoteBackupConfigRequest, DeleteBackupRequest, ModifyNameOrDescByDpIdRequest, UpgradeDBInstanceResponse, UpgradeCDBProxyVersionRequest, DeleteAuditRuleTemplatesResponse, DescribeDeviceMonitorInfoResponse, ModifyAuditRuleTemplatesResponse } from "./cdb_models";
3
+ import { CreateDBImportJobRequest, DescribeDatabasesRequest, CreateCdbProxyRequest, CreateCdbProxyResponse, DescribeTablesResponse, ModifyBackupDownloadRestrictionResponse, ModifyTimeWindowResponse, ModifyTimeWindowRequest, DescribeRollbackRangeTimeRequest, DescribeBackupOverviewRequest, DescribeAuditInstanceListResponse, ModifyDBInstanceProjectResponse, DescribeDataBackupOverviewResponse, DeleteAuditPolicyRequest, CreateDatabaseRequest, ModifyInstanceParamRequest, CreateParamTemplateRequest, DescribeParamTemplateInfoRequest, ModifyCdbProxyAddressVipAndVPortResponse, DescribeDBInstancesRequest, ModifyCdbProxyAddressDescRequest, DescribeRoGroupsRequest, DescribeBackupDecryptionKeyRequest, CreateCdbProxyAddressResponse, CloseWanServiceRequest, DescribeAuditConfigRequest, CreateRoInstanceIpResponse, CreateAuditPolicyResponse, DescribeInstanceParamRecordsRequest, StopRollbackResponse, CreateCdbProxyAddressRequest, AnalyzeAuditLogsRequest, ModifyBackupEncryptionStatusResponse, DescribeInstanceParamsRequest, DescribeUploadedFilesRequest, StopDBImportJobResponse, StopCpuExpandRequest, ModifyDBInstanceNameRequest, ModifyAuditRuleResponse, DescribeAuditRulesRequest, UpgradeDBInstanceEngineVersionResponse, AssociateSecurityGroupsResponse, DescribeCdbZoneConfigResponse, DescribeTablesRequest, UpgradeDBInstanceRequest, ModifyParamTemplateRequest, OpenAuditServiceResponse, DescribeBinlogBackupOverviewResponse, DescribeDBInstanceLogToCLSResponse, SwitchDBInstanceMasterSlaveRequest, ModifyCdbProxyAddressVipAndVPortRequest, ModifyAutoRenewFlagRequest, DeleteDeployGroupsRequest, DescribeAuditConfigResponse, ModifyBackupConfigResponse, DescribeTimeWindowResponse, DeleteAuditPolicyResponse, InitDBInstancesResponse, DescribeParamTemplateInfoResponse, DescribeInstanceParamsResponse, DeleteDatabaseRequest, DisassociateSecurityGroupsRequest, ModifyLocalBinlogConfigRequest, StartBatchRollbackResponse, ModifyAccountHostResponse, DescribeRollbackRangeTimeResponse, ModifyRoGroupInfoRequest, CreateAuditLogFileRequest, DescribeInstanceAlarmEventsRequest, DescribeBinlogsRequest, DescribeCdbProxyInfoRequest, ModifyAuditRuleTemplatesRequest, CreateAuditRuleResponse, ModifyRemoteBackupConfigResponse, DescribeDBInstanceInfoResponse, AssociateSecurityGroupsRequest, StartReplicationResponse, DescribeDBFeaturesResponse, ModifyAuditRuleRequest, DescribeBinlogsResponse, DescribeRoMinScaleRequest, DescribeDefaultParamsRequest, SwitchDBInstanceMasterSlaveResponse, DescribeBackupsRequest, DescribeInstanceParamRecordsResponse, DescribeDBInstanceGTIDResponse, DeleteParamTemplateRequest, ModifyBackupDownloadRestrictionRequest, CreateParamTemplateResponse, ModifyAccountPasswordResponse, ReleaseIsolatedDBInstancesRequest, CreateDatabaseResponse, DescribeErrorLogDataResponse, AddTimeWindowRequest, DeleteAuditLogFileResponse, DescribeDBSecurityGroupsRequest, DescribeDBSwitchRecordsResponse, CreateAuditLogFileResponse, ModifyCdbProxyParamResponse, ModifyInstanceTagResponse, DescribeDBSwitchRecordsRequest, DescribeSupportedPrivilegesRequest, DescribeAsyncRequestInfoResponse, DeleteAccountsResponse, ModifyCdbProxyAddressDescResponse, ModifyDBInstanceLogToCLSRequest, DeleteTimeWindowResponse, DescribeBackupsResponse, CreateAuditPolicyRequest, CreateRoInstanceIpRequest, OpenWanServiceRequest, StopCpuExpandResponse, DescribeBackupConfigResponse, DescribeParamTemplatesResponse, DescribeProjectSecurityGroupsRequest, StopReplicationRequest, StartCpuExpandResponse, CreateCloneInstanceResponse, DescribeCdbZoneConfigRequest, DescribeAsyncRequestInfoRequest, BalanceRoGroupLoadRequest, DescribeBackupOverviewResponse, DescribeLocalBinlogConfigRequest, DescribeDeviceMonitorInfoRequest, StopDBImportJobRequest, DescribeDBPriceRequest, ModifyAccountPrivilegesResponse, StopRollbackRequest, ResetRootAccountRequest, DescribeDBInstanceConfigRequest, ModifyAuditServiceRequest, DescribeProxyCustomConfResponse, ModifyAuditConfigResponse, SwitchDrInstanceToMasterResponse, ModifyDBInstanceNameResponse, VerifyRootAccountRequest, DescribeCloneListResponse, DescribeDBInstanceLogToCLSRequest, DescribeDBInstanceConfigResponse, StartBatchRollbackRequest, OpenDBInstanceEncryptionRequest, DescribeDBInstanceCharsetRequest, ModifyInstancePasswordComplexityResponse, DescribeRemoteBackupConfigRequest, DescribeDBInstancesResponse, DescribeBackupDownloadRestrictionRequest, CreateDeployGroupRequest, DeleteAccountsRequest, ReloadBalanceProxyNodeRequest, DescribeAccountsResponse, DescribeAuditRuleTemplateModifyHistoryResponse, DescribeAuditLogFilesRequest, ModifyBackupConfigRequest, DisassociateSecurityGroupsResponse, InquiryPriceUpgradeInstancesResponse, CreateDBInstanceRequest, DescribeParamTemplatesRequest, DescribeAccountPrivilegesResponse, DescribeAuditLogsRequest, DescribeBackupConfigRequest, DescribeAccountsRequest, DescribeErrorLogDataRequest, DescribeAuditLogFilesResponse, DescribeDBInstanceRebootTimeRequest, CreateAccountsResponse, CreateDeployGroupResponse, ResetRootAccountResponse, ModifyNameOrDescByDpIdResponse, DescribeDBPriceResponse, OpenDBInstanceGTIDResponse, VerifyRootAccountResponse, DescribeDBInstanceRebootTimeResponse, SwitchDrInstanceToMasterRequest, ModifyCdbProxyParamRequest, SwitchForUpgradeRequest, CreateDBInstanceHourResponse, DescribeBackupDownloadRestrictionResponse, ModifyDBInstanceSecurityGroupsResponse, CreateAccountsRequest, DeleteAuditRuleTemplatesRequest, CreateAuditRuleTemplateResponse, DescribeDeployGroupListRequest, CloseWanServiceResponse, RenewDBInstanceRequest, ModifyLocalBinlogConfigResponse, DeleteDatabaseResponse, DescribeCloneListRequest, ModifyInstanceTagRequest, DescribeProxySupportParamRequest, ModifyAutoRenewFlagResponse, StartReplicationRequest, ReloadBalanceProxyNodeResponse, DescribeRemoteBackupConfigResponse, DescribeDBImportRecordsResponse, DescribeProxySupportParamResponse, CloseAuditServiceResponse, DescribeRollbackTaskDetailRequest, AdjustCdbProxyResponse, ModifyParamTemplateResponse, BalanceRoGroupLoadResponse, ModifyDBInstanceVipVportResponse, DeleteAuditRuleResponse, IsolateDBInstanceRequest, DescribeDefaultParamsResponse, SwitchCDBProxyRequest, DescribeTagsOfInstanceIdsResponse, DescribeDeployGroupListResponse, OfflineIsolatedInstancesResponse, CreateAuditRuleTemplateRequest, DescribeAuditPoliciesRequest, AdjustCdbProxyAddressRequest, DescribeDatabasesResponse, DescribeRoGroupsResponse, CloseCdbProxyAddressResponse, DescribeAuditRulesResponse, ModifyAccountHostRequest, CreateAuditRuleRequest, ModifyAccountPrivilegesRequest, CreateBackupRequest, DescribeTimeWindowRequest, AdjustCdbProxyAddressResponse, ModifyDBInstanceVipVportRequest, DescribeDBImportRecordsRequest, CreateDBImportJobResponse, DescribeTagsOfInstanceIdsRequest, StartCpuExpandRequest, DescribeCpuExpandStrategyRequest, CloseCDBProxyResponse, StopReplicationResponse, UpgradeDBInstanceEngineVersionRequest, DescribeDataBackupOverviewRequest, DescribeDBInstanceInfoRequest, ModifyDBInstanceProjectRequest, SwitchForUpgradeResponse, DescribeAccountPrivilegesRequest, DescribeSupportedPrivilegesResponse, DescribeLocalBinlogConfigResponse, ModifyAuditServiceResponse, ModifyInstancePasswordComplexityRequest, OpenWanServiceResponse, DescribeDBInstanceGTIDRequest, DescribeBackupEncryptionStatusResponse, DescribeCdbProxyInfoResponse, ModifyAuditConfigRequest, DescribeInstanceAlarmEventsResponse, DescribeRoMinScaleResponse, DescribeSlowLogDataResponse, RestartDBInstancesResponse, DescribeSlowLogsRequest, DescribeProxyCustomConfRequest, DescribeDBSecurityGroupsResponse, CloseCdbProxyAddressRequest, ModifyRoGroupInfoResponse, DeleteAuditRuleRequest, DeleteParamTemplateResponse, DescribeAuditRuleTemplateModifyHistoryRequest, DescribeTasksResponse, DescribeAuditLogsResponse, DescribeAuditPoliciesResponse, IsolateDBInstanceResponse, AdjustCdbProxyRequest, ModifyAccountDescriptionResponse, ModifyAccountMaxUserConnectionsRequest, DeleteDeployGroupsResponse, DescribeTasksRequest, ModifyBackupEncryptionStatusRequest, DescribeRollbackTaskDetailResponse, CreateDBInstanceHourRequest, DescribeAuditRuleTemplatesResponse, CreateCloneInstanceRequest, CloseCDBProxyRequest, DeleteBackupResponse, DescribeProjectSecurityGroupsResponse, DescribeBackupSummariesRequest, AnalyzeAuditLogsResponse, CreateDBInstanceResponse, OpenAuditServiceRequest, DescribeDBInstanceCharsetResponse, DescribeDBFeaturesRequest, DescribeBackupSummariesResponse, DescribeBinlogBackupOverviewRequest, ModifyDBInstanceSecurityGroupsRequest, CloseAuditServiceRequest, ModifyAccountMaxUserConnectionsResponse, DescribeBackupDecryptionKeyResponse, OfflineIsolatedInstancesRequest, InquiryPriceUpgradeInstancesRequest, ModifyInstanceParamResponse, DescribeUploadedFilesResponse, InitDBInstancesRequest, CreateBackupResponse, OpenDBInstanceGTIDRequest, OpenDBInstanceEncryptionResponse, UpgradeCDBProxyVersionResponse, ModifyAccountDescriptionRequest, ModifyAccountPasswordRequest, DescribeCpuExpandStrategyResponse, RenewDBInstanceResponse, AddTimeWindowResponse, DescribeAuditInstanceListRequest, DescribeBackupEncryptionStatusRequest, ModifyDBInstanceLogToCLSResponse, DescribeAuditRuleTemplatesRequest, DescribeSlowLogDataRequest, ReleaseIsolatedDBInstancesResponse, DeleteAuditLogFileRequest, DescribeSlowLogsResponse, DeleteTimeWindowRequest, SwitchCDBProxyResponse, RestartDBInstancesRequest, ModifyRemoteBackupConfigRequest, DeleteBackupRequest, ModifyNameOrDescByDpIdRequest, UpgradeDBInstanceResponse, UpgradeCDBProxyVersionRequest, DeleteAuditRuleTemplatesResponse, DescribeDeviceMonitorInfoResponse, ModifyAuditRuleTemplatesResponse } from "./cdb_models";
4
4
  /**
5
5
  * cdb client
6
6
  * @class
@@ -435,6 +435,10 @@ export declare class Client extends AbstractClient {
435
435
  * 关闭数据库代理
436
436
  */
437
437
  CloseCDBProxy(req: CloseCDBProxyRequest, cb?: (error: string, rep: CloseCDBProxyResponse) => void): Promise<CloseCDBProxyResponse>;
438
+ /**
439
+ * 修改置放群组的名称或者描述
440
+ */
441
+ ModifyNameOrDescByDpId(req: ModifyNameOrDescByDpIdRequest, cb?: (error: string, rep: ModifyNameOrDescByDpIdResponse) => void): Promise<ModifyNameOrDescByDpIdResponse>;
438
442
  /**
439
443
  * 本接口(ModifyAccountMaxUserConnections)用于修改云数据库账户最大可用连接数。
440
444
  */
@@ -668,9 +672,9 @@ export declare class Client extends AbstractClient {
668
672
  */
669
673
  DescribeCloneList(req: DescribeCloneListRequest, cb?: (error: string, rep: DescribeCloneListResponse) => void): Promise<DescribeCloneListResponse>;
670
674
  /**
671
- * 修改置放群组的名称或者描述
675
+ * 查询实例发生的事件信息
672
676
  */
673
- ModifyNameOrDescByDpId(req: ModifyNameOrDescByDpIdRequest, cb?: (error: string, rep: ModifyNameOrDescByDpIdResponse) => void): Promise<ModifyNameOrDescByDpIdResponse>;
677
+ DescribeInstanceAlarmEvents(req?: DescribeInstanceAlarmEventsRequest, cb?: (error: string, rep: DescribeInstanceAlarmEventsResponse) => void): Promise<DescribeInstanceAlarmEventsResponse>;
674
678
  /**
675
679
  * 本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。
676
680
  */
@@ -651,6 +651,12 @@ class Client extends abstract_client_1.AbstractClient {
651
651
  async CloseCDBProxy(req, cb) {
652
652
  return this.request("CloseCDBProxy", req, cb);
653
653
  }
654
+ /**
655
+ * 修改置放群组的名称或者描述
656
+ */
657
+ async ModifyNameOrDescByDpId(req, cb) {
658
+ return this.request("ModifyNameOrDescByDpId", req, cb);
659
+ }
654
660
  /**
655
661
  * 本接口(ModifyAccountMaxUserConnections)用于修改云数据库账户最大可用连接数。
656
662
  */
@@ -994,10 +1000,10 @@ class Client extends abstract_client_1.AbstractClient {
994
1000
  return this.request("DescribeCloneList", req, cb);
995
1001
  }
996
1002
  /**
997
- * 修改置放群组的名称或者描述
1003
+ * 查询实例发生的事件信息
998
1004
  */
999
- async ModifyNameOrDescByDpId(req, cb) {
1000
- return this.request("ModifyNameOrDescByDpId", req, cb);
1005
+ async DescribeInstanceAlarmEvents(req, cb) {
1006
+ return this.request("DescribeInstanceAlarmEvents", req, cb);
1001
1007
  }
1002
1008
  /**
1003
1009
  * 本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。
@@ -2200,6 +2200,10 @@ export interface AuditRule {
2200
2200
  */
2201
2201
  AuditAll: boolean;
2202
2202
  }
2203
+ /**
2204
+ * DescribeInstanceAlarmEvents请求参数结构体
2205
+ */
2206
+ export declare type DescribeInstanceAlarmEventsRequest = null;
2203
2207
  /**
2204
2208
  * DescribeBinlogs请求参数结构体
2205
2209
  */
@@ -7329,6 +7333,15 @@ export interface DeviceDiskInfo {
7329
7333
  */
7330
7334
  CapacityRatio: Array<number | bigint>;
7331
7335
  }
7336
+ /**
7337
+ * DescribeInstanceAlarmEvents返回参数结构体
7338
+ */
7339
+ export interface DescribeInstanceAlarmEventsResponse {
7340
+ /**
7341
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7342
+ */
7343
+ RequestId?: string;
7344
+ }
7332
7345
  /**
7333
7346
  * DescribeRoMinScale返回参数结构体
7334
7347
  */
@@ -102,27 +102,27 @@ export interface ScaleOutInstanceResponse {
102
102
  /**
103
103
  * 实例ID。
104
104
  */
105
- InstanceId: string;
105
+ InstanceId?: string;
106
106
  /**
107
107
  * 订单号。
108
108
  注意:此字段可能返回 null,表示取不到有效值。
109
109
  */
110
- DealNames: Array<string>;
110
+ DealNames?: Array<string>;
111
111
  /**
112
112
  * 客户端Token。
113
113
  注意:此字段可能返回 null,表示取不到有效值。
114
114
  */
115
- ClientToken: string;
115
+ ClientToken?: string;
116
116
  /**
117
117
  * 扩容流程ID。
118
118
  注意:此字段可能返回 null,表示取不到有效值。
119
119
  */
120
- FlowId: number;
120
+ FlowId?: number;
121
121
  /**
122
122
  * 大订单号。
123
123
  注意:此字段可能返回 null,表示取不到有效值。
124
124
  */
125
- BillId: string;
125
+ BillId?: string;
126
126
  /**
127
127
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
128
128
  */
@@ -1083,7 +1083,7 @@ export interface ScaleOutInstanceRequest {
1083
1083
  */
1084
1084
  PayMode: number;
1085
1085
  /**
1086
- * 客户端Token。
1086
+ * 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280
1087
1087
  */
1088
1088
  ClientToken?: string;
1089
1089
  /**
@@ -1444,143 +1444,148 @@ export interface EmrListInstance {
1444
1444
  /**
1445
1445
  * 集群ID
1446
1446
  */
1447
- ClusterId: string;
1447
+ ClusterId?: string;
1448
1448
  /**
1449
1449
  * 状态描述
1450
1450
  注意:此字段可能返回 null,表示取不到有效值。
1451
1451
  */
1452
- StatusDesc: string;
1452
+ StatusDesc?: string;
1453
1453
  /**
1454
1454
  * 集群名字
1455
1455
  */
1456
- ClusterName: string;
1456
+ ClusterName?: string;
1457
1457
  /**
1458
1458
  * 集群地域
1459
1459
  */
1460
- ZoneId: number;
1460
+ ZoneId?: number;
1461
1461
  /**
1462
1462
  * 用户APPID
1463
1463
  */
1464
- AppId: number;
1464
+ AppId?: number;
1465
1465
  /**
1466
1466
  * 创建时间
1467
1467
  */
1468
- AddTime: string;
1468
+ AddTime?: string;
1469
1469
  /**
1470
1470
  * 运行时间
1471
1471
  */
1472
- RunTime: string;
1472
+ RunTime?: string;
1473
1473
  /**
1474
1474
  * 集群IP
1475
1475
  */
1476
- MasterIp: string;
1476
+ MasterIp?: string;
1477
1477
  /**
1478
1478
  * 集群版本
1479
1479
  */
1480
- EmrVersion: string;
1480
+ EmrVersion?: string;
1481
1481
  /**
1482
1482
  * 集群计费类型
1483
1483
  */
1484
- ChargeType: number;
1484
+ ChargeType?: number;
1485
1485
  /**
1486
1486
  * emr ID
1487
1487
  */
1488
- Id: number;
1488
+ Id?: number;
1489
1489
  /**
1490
1490
  * 产品ID
1491
1491
  注意:此字段可能返回 null,表示取不到有效值。
1492
1492
  */
1493
- ProductId: number;
1493
+ ProductId?: number;
1494
1494
  /**
1495
1495
  * 项目ID
1496
1496
  注意:此字段可能返回 null,表示取不到有效值。
1497
1497
  */
1498
- ProjectId: number;
1498
+ ProjectId?: number;
1499
1499
  /**
1500
1500
  * 区域
1501
1501
  注意:此字段可能返回 null,表示取不到有效值。
1502
1502
  */
1503
- RegionId: number;
1503
+ RegionId?: number;
1504
1504
  /**
1505
1505
  * 子网ID
1506
1506
  注意:此字段可能返回 null,表示取不到有效值。
1507
1507
  */
1508
- SubnetId: number;
1508
+ SubnetId?: number;
1509
1509
  /**
1510
1510
  * 网络ID
1511
1511
  注意:此字段可能返回 null,表示取不到有效值。
1512
1512
  */
1513
- VpcId: number;
1513
+ VpcId?: number;
1514
1514
  /**
1515
1515
  * 地区
1516
1516
  注意:此字段可能返回 null,表示取不到有效值。
1517
1517
  */
1518
- Zone: string;
1518
+ Zone?: string;
1519
1519
  /**
1520
1520
  * 状态码
1521
1521
  注意:此字段可能返回 null,表示取不到有效值。
1522
1522
  */
1523
- Status: number;
1523
+ Status?: number;
1524
1524
  /**
1525
1525
  * 实例标签
1526
1526
  注意:此字段可能返回 null,表示取不到有效值。
1527
1527
  */
1528
- Tags: Array<Tag>;
1528
+ Tags?: Array<Tag>;
1529
1529
  /**
1530
1530
  * 告警信息
1531
1531
  注意:此字段可能返回 null,表示取不到有效值。
1532
1532
  */
1533
- AlarmInfo: string;
1533
+ AlarmInfo?: string;
1534
1534
  /**
1535
1535
  * 是否是woodpecker集群
1536
1536
  注意:此字段可能返回 null,表示取不到有效值。
1537
1537
  */
1538
- IsWoodpeckerCluster: number;
1538
+ IsWoodpeckerCluster?: number;
1539
1539
  /**
1540
1540
  * Vpc中文
1541
1541
  注意:此字段可能返回 null,表示取不到有效值。
1542
1542
  */
1543
- VpcName: string;
1543
+ VpcName?: string;
1544
1544
  /**
1545
1545
  * 子网中文
1546
1546
  注意:此字段可能返回 null,表示取不到有效值。
1547
1547
  */
1548
- SubnetName: string;
1548
+ SubnetName?: string;
1549
1549
  /**
1550
1550
  * 字符串VpcId
1551
1551
  注意:此字段可能返回 null,表示取不到有效值。
1552
1552
  */
1553
- UniqVpcId: string;
1553
+ UniqVpcId?: string;
1554
1554
  /**
1555
1555
  * 字符串子网
1556
1556
  注意:此字段可能返回 null,表示取不到有效值。
1557
1557
  */
1558
- UniqSubnetId: string;
1558
+ UniqSubnetId?: string;
1559
1559
  /**
1560
1560
  * 集群类型
1561
1561
  注意:此字段可能返回 null,表示取不到有效值。
1562
1562
  */
1563
- ClusterClass: string;
1563
+ ClusterClass?: string;
1564
1564
  /**
1565
1565
  * 是否为跨AZ集群
1566
1566
  注意:此字段可能返回 null,表示取不到有效值。
1567
1567
  */
1568
- IsMultiZoneCluster: boolean;
1568
+ IsMultiZoneCluster?: boolean;
1569
1569
  /**
1570
1570
  * 是否手戳集群
1571
1571
  注意:此字段可能返回 null,表示取不到有效值。
1572
1572
  */
1573
- IsHandsCluster: boolean;
1573
+ IsHandsCluster?: boolean;
1574
1574
  /**
1575
1575
  * 体外客户端组件信息
1576
1576
  注意:此字段可能返回 null,表示取不到有效值。
1577
1577
  */
1578
- OutSideSoftInfo: Array<SoftDependInfo>;
1578
+ OutSideSoftInfo?: Array<SoftDependInfo>;
1579
1579
  /**
1580
1580
  * 当前集群的应用场景是否支持体外客户端
1581
1581
  注意:此字段可能返回 null,表示取不到有效值。
1582
1582
  */
1583
1583
  IsSupportOutsideCluster?: boolean;
1584
+ /**
1585
+ * 是否专有集群场景集群
1586
+ 注意:此字段可能返回 null,表示取不到有效值。
1587
+ */
1588
+ IsDedicatedCluster?: boolean;
1584
1589
  }
1585
1590
  /**
1586
1591
  * AddUsersForUserManager返回参数结构体
@@ -3832,7 +3837,7 @@ export interface CreateInstanceRequest {
3832
3837
  */
3833
3838
  AutoRenew?: number;
3834
3839
  /**
3835
- * 客户端Token。
3840
+ * 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280
3836
3841
  */
3837
3842
  ClientToken?: string;
3838
3843
  /**
@@ -49,9 +49,16 @@ export declare class Client extends AbstractClient {
49
49
  /**
50
50
  * 用于撤销合同流程<br/>
51
51
  适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
52
+ - **可撤回合同状态**:未全部签署完成
53
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
52
54
 
53
55
  注:
54
- `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
56
+ 1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
57
+
58
+ 2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
59
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
60
+
61
+ 3. <font color='red'>撤销合同会返还合同额度</font>
55
62
  */
56
63
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
57
64
  /**
@@ -157,9 +164,20 @@ export declare class Client extends AbstractClient {
157
164
  */
158
165
  UnbindEmployeeUserIdWithClientOpenId(req: UnbindEmployeeUserIdWithClientOpenIdRequest, cb?: (error: string, rep: UnbindEmployeeUserIdWithClientOpenIdResponse) => void): Promise<UnbindEmployeeUserIdWithClientOpenIdResponse>;
159
166
  /**
160
- * 注:此接口将会废弃,请使用撤销单个签署流程(CancelFlow)接口。
161
- 指定需要批量撤回的签署流程Id,获取批量撤销链接。
162
- 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。
167
+ * 指定需要批量撤回的签署流程Id,以获取批量撤销链接。
168
+ 客户需指定要撤回的签署流程Id,最多可指定100个,超过100则不处理。
169
+ 接口调用成功后,将返回批量撤回合同的链接。通过点击链接,可跳转至电子签小程序完成批量撤回操作。
170
+
171
+ - **可撤回合同状态**:未全部签署完成
172
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
173
+
174
+ 注:
175
+ 1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
176
+
177
+ 2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
178
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
179
+
180
+ 3. <font color='red'>撤销合同会返还合同额度</font>
163
181
  */
164
182
  CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
165
183
  /**
@@ -77,9 +77,16 @@ class Client extends abstract_client_1.AbstractClient {
77
77
  /**
78
78
  * 用于撤销合同流程<br/>
79
79
  适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
80
+ - **可撤回合同状态**:未全部签署完成
81
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
80
82
 
81
83
  注:
82
- `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
84
+ 1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
85
+
86
+ 2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
87
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
88
+
89
+ 3. <font color='red'>撤销合同会返还合同额度</font>
83
90
  */
84
91
  async CancelFlow(req, cb) {
85
92
  return this.request("CancelFlow", req, cb);
@@ -207,9 +214,20 @@ class Client extends abstract_client_1.AbstractClient {
207
214
  return this.request("UnbindEmployeeUserIdWithClientOpenId", req, cb);
208
215
  }
209
216
  /**
210
- * 注:此接口将会废弃,请使用撤销单个签署流程(CancelFlow)接口。
211
- 指定需要批量撤回的签署流程Id,获取批量撤销链接。
212
- 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。
217
+ * 指定需要批量撤回的签署流程Id,以获取批量撤销链接。
218
+ 客户需指定要撤回的签署流程Id,最多可指定100个,超过100则不处理。
219
+ 接口调用成功后,将返回批量撤回合同的链接。通过点击链接,可跳转至电子签小程序完成批量撤回操作。
220
+
221
+ - **可撤回合同状态**:未全部签署完成
222
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
223
+
224
+ 注:
225
+ 1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
226
+
227
+ 2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
228
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
229
+
230
+ 3. <font color='red'>撤销合同会返还合同额度</font>
213
231
  */
214
232
  async CreateBatchCancelFlowUrl(req, cb) {
215
233
  return this.request("CreateBatchCancelFlowUrl", req, cb);
@@ -1889,7 +1889,10 @@ export interface CreateSchemeUrlRequest {
1889
1889
  /**
1890
1890
  * 签署完成后是否自动回跳
1891
1891
  <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
1892
- 注: ` 该参数只针对"APP" 类型的签署链接有效`
1892
+
1893
+ 注:
1894
+ 1. 该参数<font color="red">只针对APP</font> 类型的签署链接有效
1895
+ 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
1893
1896
  */
1894
1897
  AutoJumpBack?: boolean;
1895
1898
  /**
@@ -3524,20 +3527,24 @@ style String 为字体风格设置 风格支持: font : 目前支持 黑体、
3524
3527
  export interface FormField {
3525
3528
  /**
3526
3529
  * 控件填充vaule,ComponentType和传入值类型对应关系:
3527
- TEXT - 文本内容
3528
- MULTI_LINE_TEXT - 文本内容
3529
- CHECK_BOX - true/false
3530
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
3531
- SELECTOR - 选项值
3532
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
3530
+ TEXT 文本内容
3531
+ MULTI_LINE_TEXT :文本内容
3532
+ CHECK_BOX true/false
3533
+ FILL_IMAGE、ATTACHMENT 附件的FileId,需要通过UploadFiles接口上传获取
3534
+ SELECTOR 选项值
3535
+ DYNAMIC_TABLE :传入json格式的表格内容,具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)
3533
3536
  */
3534
3537
  ComponentValue: string;
3535
3538
  /**
3536
3539
  * 控件id,和ComponentName选择一项传入即可
3540
+
3541
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件ID的方式</a>
3537
3542
  */
3538
3543
  ComponentId?: string;
3539
3544
  /**
3540
3545
  * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
3546
+
3547
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件名字的方式</a>
3541
3548
  */
3542
3549
  ComponentName?: string;
3543
3550
  }
@@ -6035,11 +6042,13 @@ export interface CancelFlowRequest {
6035
6042
  /**
6036
6043
  * 合同流程ID, 为32位字符串。
6037
6044
 
6038
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)
6045
+ 可登录腾讯电子签控制台,[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
6039
6046
  */
6040
6047
  FlowId: string;
6041
6048
  /**
6042
- * 撤销此合同流程的原因,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
6049
+ * 撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
6050
+
6051
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
6043
6052
  */
6044
6053
  CancelMessage: string;
6045
6054
  /**
@@ -7020,7 +7029,7 @@ export interface CreateBatchCancelFlowUrlRequest {
7020
7029
  Operator: UserInfo;
7021
7030
  /**
7022
7031
  * 需要执行撤回的流程(合同)的编号列表,最多100个.
7023
- <br>列表中的流程(合同)编号不要重复.
7032
+ 列表中的流程(合同)编号不要重复.
7024
7033
  */
7025
7034
  FlowIds: Array<string>;
7026
7035
  /**