tencentcloud-sdk-nodejs 4.0.789 → 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.
- package/CHANGELOG.md +414 -0
- package/README.md +6 -0
- package/SERVICE_CHANGELOG.md +939 -260
- package/examples/cls/v20201016/cls.proto +34 -0
- package/examples/cls/v20201016/upload_log.js +69 -0
- package/package.json +1 -1
- package/products.md +12 -12
- package/src/common/abstract_client.ts +32 -0
- package/src/common/http/http_connection.ts +5 -2
- package/src/common/sdk_version.ts +1 -1
- package/src/common/sign.ts +8 -4
- package/src/services/cdb/v20170320/cdb_client.ts +18 -6
- package/src/services/cdb/v20170320/cdb_models.ts +15 -0
- package/src/services/emr/v20190103/emr_models.ts +7 -7
- package/src/services/ess/v20201111/ess_client.ts +22 -4
- package/src/services/ess/v20201111/ess_models.ts +19 -10
- package/src/services/essbasic/v20210526/essbasic_client.ts +11 -9
- package/src/services/essbasic/v20210526/essbasic_models.ts +4 -0
- package/src/services/iotvideo/v20211125/iotvideo_models.ts +8 -0
- package/src/services/mna/v20210119/mna_models.ts +3 -3
- package/src/services/rum/v20210622/rum_models.ts +2 -1
- package/src/services/ssl/v20191205/ssl_models.ts +2 -3
- package/src/services/teo/v20220901/teo_client.ts +20 -15
- package/src/services/teo/v20220901/teo_models.ts +8 -4
- package/src/services/tmt/v20180321/tmt_models.ts +2 -2
- package/src/services/wedata/v20210820/wedata_client.ts +2802 -5338
- package/src/services/wedata/v20210820/wedata_models.ts +14500 -29440
- package/tencentcloud/common/abstract_client.d.ts +4 -0
- package/tencentcloud/common/abstract_client.js +22 -0
- package/tencentcloud/common/http/http_connection.js +6 -2
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/common/sign.d.ts +2 -1
- package/tencentcloud/common/sign.js +6 -4
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +7 -3
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +9 -3
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +13 -0
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +7 -7
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +22 -4
- package/tencentcloud/services/ess/v20201111/ess_client.js +22 -4
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -10
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -9
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -9
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -0
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +8 -0
- package/tencentcloud/services/mna/v20210119/mna_models.d.ts +3 -3
- package/tencentcloud/services/rum/v20210622/rum_models.d.ts +2 -1
- package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +2 -3
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +15 -10
- package/tencentcloud/services/teo/v20220901/teo_client.js +15 -10
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +8 -4
- package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +2 -2
- package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +675 -1483
- package/tencentcloud/services/wedata/v20210820/wedata_client.js +1027 -2237
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14275 -28693
- package/test/cdb.v20170320.test.js +12 -2
- 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 =
|
|
84
|
-
config.headers["Content-Type"]
|
|
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.
|
|
1
|
+
export declare const 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 =
|
|
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 =
|
|
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
|
-
|
|
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" +
|
|
@@ -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
|
-
|
|
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
|
|
1000
|
-
return this.request("
|
|
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
|
|
105
|
+
InstanceId?: string;
|
|
106
106
|
/**
|
|
107
107
|
* 订单号。
|
|
108
108
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
109
109
|
*/
|
|
110
|
-
DealNames
|
|
110
|
+
DealNames?: Array<string>;
|
|
111
111
|
/**
|
|
112
112
|
* 客户端Token。
|
|
113
113
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
114
114
|
*/
|
|
115
|
-
ClientToken
|
|
115
|
+
ClientToken?: string;
|
|
116
116
|
/**
|
|
117
117
|
* 扩容流程ID。
|
|
118
118
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
119
119
|
*/
|
|
120
|
-
FlowId
|
|
120
|
+
FlowId?: number;
|
|
121
121
|
/**
|
|
122
122
|
* 大订单号。
|
|
123
123
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
124
124
|
*/
|
|
125
|
-
BillId
|
|
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
|
-
*
|
|
1086
|
+
* 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280
|
|
1087
1087
|
*/
|
|
1088
1088
|
ClientToken?: string;
|
|
1089
1089
|
/**
|
|
@@ -3837,7 +3837,7 @@ export interface CreateInstanceRequest {
|
|
|
3837
3837
|
*/
|
|
3838
3838
|
AutoRenew?: number;
|
|
3839
3839
|
/**
|
|
3840
|
-
*
|
|
3840
|
+
* 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280
|
|
3841
3841
|
*/
|
|
3842
3842
|
ClientToken?: string;
|
|
3843
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
|
-
|
|
56
|
+
1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
|
|
57
|
+
|
|
58
|
+
2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
|
|
59
|
+

|
|
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
|
-
*
|
|
161
|
-
|
|
162
|
-
|
|
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
|
+

|
|
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
|
-
|
|
84
|
+
1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
|
|
85
|
+
|
|
86
|
+
2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
|
|
87
|
+

|
|
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
|
-
*
|
|
211
|
-
|
|
212
|
-
|
|
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
|
+

|
|
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
|
-
|
|
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
|
|
3530
|
-
FILL_IMAGE、ATTACHMENT
|
|
3531
|
-
SELECTOR
|
|
3532
|
-
DYNAMIC_TABLE
|
|
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
|
-
|
|
6045
|
+
可登录腾讯电子签控制台,[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
6039
6046
|
*/
|
|
6040
6047
|
FlowId: string;
|
|
6041
6048
|
/**
|
|
6042
|
-
*
|
|
6049
|
+
* 撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
|
|
6050
|
+
|
|
6051
|
+

|
|
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
|
-
|
|
7032
|
+
列表中的流程(合同)编号不要重复.
|
|
7024
7033
|
*/
|
|
7025
7034
|
FlowIds: Array<string>;
|
|
7026
7035
|
/**
|
|
@@ -252,7 +252,7 @@ export declare class Client extends AbstractClient {
|
|
|
252
252
|
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
253
253
|
|
|
254
254
|
注:
|
|
255
|
-
- 有对应合同撤销权限的人: <font color='red'
|
|
255
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
256
256
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
257
257
|
*/
|
|
258
258
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
@@ -334,13 +334,15 @@ export declare class Client extends AbstractClient {
|
|
|
334
334
|
</table>
|
|
335
335
|
|
|
336
336
|
**注**:
|
|
337
|
-
|
|
337
|
+
1. 发起合同时候, 作为<font color="red">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名
|
|
338
338
|
|
|
339
|
-
|
|
339
|
+
2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
|
|
340
340
|
|
|
341
|
-
|
|
341
|
+
3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)
|
|
342
342
|
|
|
343
|
-
|
|
343
|
+
4. <font color="red">静默(自动)签署不支持合同签署方存在填写</font>
|
|
344
|
+
|
|
345
|
+
5. <font color="red">在下一步创建签署链接前,建议等待DocumentFill </font>[PDF合成完成的回调](https://qian.tencent.com/developers/partner/callback_types_file_resources)或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
|
|
344
346
|
*/
|
|
345
347
|
CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
|
|
346
348
|
/**
|
|
@@ -546,7 +548,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
546
548
|
*/
|
|
547
549
|
ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
|
|
548
550
|
/**
|
|
549
|
-
* 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'
|
|
551
|
+
* 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
|
|
550
552
|
|
|
551
553
|
适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
552
554
|
|
|
@@ -689,7 +691,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
689
691
|
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
690
692
|
|
|
691
693
|
注:
|
|
692
|
-
- 有对应合同撤销权限的人: <font color='red'
|
|
694
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
693
695
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
694
696
|
*/
|
|
695
697
|
ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
|
|
@@ -937,9 +939,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
937
939
|
/**
|
|
938
940
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
939
941
|
|
|
940
|
-
- **新增员工的场景**:
|
|
942
|
+
- **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
941
943
|
|
|
942
|
-
- **员工离职的场景**:
|
|
944
|
+
- **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
943
945
|
|
|
944
946
|

|
|
945
947
|
|
|
@@ -302,7 +302,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
302
302
|
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
303
303
|
|
|
304
304
|
注:
|
|
305
|
-
- 有对应合同撤销权限的人: <font color='red'
|
|
305
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
306
306
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
307
307
|
*/
|
|
308
308
|
async ChannelCancelFlow(req, cb) {
|
|
@@ -392,13 +392,15 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
392
392
|
</table>
|
|
393
393
|
|
|
394
394
|
**注**:
|
|
395
|
-
|
|
395
|
+
1. 发起合同时候, 作为<font color="red">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名
|
|
396
396
|
|
|
397
|
-
|
|
397
|
+
2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
|
|
398
398
|
|
|
399
|
-
|
|
399
|
+
3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)
|
|
400
400
|
|
|
401
|
-
|
|
401
|
+
4. <font color="red">静默(自动)签署不支持合同签署方存在填写</font>
|
|
402
|
+
|
|
403
|
+
5. <font color="red">在下一步创建签署链接前,建议等待DocumentFill </font>[PDF合成完成的回调](https://qian.tencent.com/developers/partner/callback_types_file_resources)或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
|
|
402
404
|
*/
|
|
403
405
|
async CreateFlowsByTemplates(req, cb) {
|
|
404
406
|
return this.request("CreateFlowsByTemplates", req, cb);
|
|
@@ -626,7 +628,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
626
628
|
return this.request("ChannelCreatePrepareFlow", req, cb);
|
|
627
629
|
}
|
|
628
630
|
/**
|
|
629
|
-
* 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'
|
|
631
|
+
* 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
|
|
630
632
|
|
|
631
633
|
适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
632
634
|
|
|
@@ -797,7 +799,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
797
799
|
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
798
800
|
|
|
799
801
|
注:
|
|
800
|
-
- 有对应合同撤销权限的人: <font color='red'
|
|
802
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
|
|
801
803
|
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
802
804
|
*/
|
|
803
805
|
async ChannelBatchCancelFlows(req, cb) {
|
|
@@ -1077,9 +1079,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
1077
1079
|
/**
|
|
1078
1080
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
1079
1081
|
|
|
1080
|
-
- **新增员工的场景**:
|
|
1082
|
+
- **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
1081
1083
|
|
|
1082
|
-
- **员工离职的场景**:
|
|
1084
|
+
- **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
1083
1085
|
|
|
1084
1086
|

|
|
1085
1087
|
|
|
@@ -1655,11 +1655,15 @@ export interface FormField {
|
|
|
1655
1655
|
/**
|
|
1656
1656
|
* 表单域或控件的ID,跟ComponentName二选一,不能全为空;
|
|
1657
1657
|
CreateFlowsByTemplates 接口不使用此字段。
|
|
1658
|
+
|
|
1659
|
+
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
|
|
1658
1660
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1659
1661
|
*/
|
|
1660
1662
|
ComponentId?: string;
|
|
1661
1663
|
/**
|
|
1662
1664
|
* 控件的名字,跟ComponentId二选一,不能全为空
|
|
1665
|
+
|
|
1666
|
+
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
|
|
1663
1667
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1664
1668
|
*/
|
|
1665
1669
|
ComponentName?: string;
|
|
@@ -303,6 +303,10 @@ export interface DescribeDevicePackagesRequest {
|
|
|
303
303
|
* 分页拉取偏移
|
|
304
304
|
*/
|
|
305
305
|
Offset: number;
|
|
306
|
+
/**
|
|
307
|
+
* 通道id
|
|
308
|
+
*/
|
|
309
|
+
ChannelId?: number;
|
|
306
310
|
}
|
|
307
311
|
/**
|
|
308
312
|
* ReportAliveDevice请求参数结构体
|
|
@@ -1001,6 +1005,10 @@ export interface PackageInfo {
|
|
|
1001
1005
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1002
1006
|
*/
|
|
1003
1007
|
OrderId?: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* 通道id
|
|
1010
|
+
*/
|
|
1011
|
+
ChannelId?: number;
|
|
1004
1012
|
}
|
|
1005
1013
|
/**
|
|
1006
1014
|
* DescribeFirmware请求参数结构体
|