tencentcloud-sdk-nodejs 4.1.301 → 4.1.303

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 (45) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/emr/v20190103/emr_client.js +3 -0
  3. package/es/services/ess/v20201111/ess_client.js +3 -0
  4. package/es/services/essbasic/v20210526/essbasic_client.js +5 -2
  5. package/es/services/monitor/v20230616/monitor_client.js +32 -2
  6. package/es/services/mps/v20190612/mps_client.js +5 -2
  7. package/es/services/tcr/v20190924/tcr_client.js +6 -0
  8. package/package.json +1 -1
  9. package/tencentcloud/common/sdk_version.d.ts +1 -1
  10. package/tencentcloud/common/sdk_version.js +1 -1
  11. package/tencentcloud/services/adp/v20260520/adp_models.d.ts +32 -3
  12. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +1 -1
  13. package/tencentcloud/services/asr/v20190614/asr_client.js +1 -1
  14. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +111 -45
  15. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +5 -5
  16. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
  17. package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
  18. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +26 -0
  19. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +119 -1
  20. package/tencentcloud/services/ess/v20201111/ess_client.js +120 -0
  21. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +42 -0
  22. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +127 -6
  23. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +129 -6
  24. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +46 -0
  25. package/tencentcloud/services/fwm/v20250611/fwm_models.d.ts +48 -28
  26. package/tencentcloud/services/goosefs/v20220519/goosefs_models.d.ts +20 -4
  27. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +40 -40
  28. package/tencentcloud/services/monitor/v20230616/monitor_client.d.ts +43 -3
  29. package/tencentcloud/services/monitor/v20230616/monitor_client.js +63 -3
  30. package/tencentcloud/services/monitor/v20230616/monitor_models.d.ts +557 -74
  31. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +7 -3
  32. package/tencentcloud/services/mps/v20190612/mps_client.js +9 -3
  33. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +66 -16
  34. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +15 -7
  35. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +1 -1
  36. package/tencentcloud/services/tcb/v20180608/tcb_client.js +1 -1
  37. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +155 -37
  38. package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +9 -1
  39. package/tencentcloud/services/tcr/v20190924/tcr_client.js +12 -0
  40. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +186 -24
  41. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +1 -0
  42. package/tencentcloud/services/teo/v20220901/teo_client.js +1 -0
  43. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +22 -27
  44. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +164 -136
  45. package/tencentcloud/services/wedata/v20250806/wedata_models.d.ts +49 -20
@@ -989,6 +989,19 @@ export interface JobFlowResourceSpec {
989
989
  */
990
990
  CommonResourceSpec?: JobFlowResource;
991
991
  }
992
+ /**
993
+ * DescribeMetaDBInfo返回参数结构体
994
+ */
995
+ export interface DescribeMetaDBInfoResponse {
996
+ /**
997
+ * <p>自定义db数据</p>
998
+ */
999
+ MetaDBGroupInfo?: Array<CustomMetaDBInfo>;
1000
+ /**
1001
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1002
+ */
1003
+ RequestId?: string;
1004
+ }
992
1005
  /**
993
1006
  * WebUI访问信息
994
1007
  */
@@ -4433,6 +4446,10 @@ export interface CreateClusterRequest {
4433
4446
  * <p>系统盘是否加密</p>
4434
4447
  */
4435
4448
  EnableCbsSysEncryptFlag?: boolean;
4449
+ /**
4450
+ * <p>自定义metadb数据</p>
4451
+ */
4452
+ MetaDBGroupInfo?: Array<CustomMetaDBInfo>;
4436
4453
  }
4437
4454
  /**
4438
4455
  * CreateSLInstance返回参数结构体
@@ -7311,6 +7328,15 @@ export interface ModifyYarnDeployResponse {
7311
7328
  */
7312
7329
  RequestId?: string;
7313
7330
  }
7331
+ /**
7332
+ * DescribeMetaDBInfo请求参数结构体
7333
+ */
7334
+ export interface DescribeMetaDBInfoRequest {
7335
+ /**
7336
+ * <p>集群id</p>
7337
+ */
7338
+ InstanceId: string;
7339
+ }
7314
7340
  /**
7315
7341
  * 用户管理中用户的简要信息
7316
7342
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateOrganizationGroupInvitationLinkRequest, DescribeCancelFlowsTaskResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeContractReviewWebUrlRequest, DescribeInformationExtractionTaskRequest, CreateDynamicFlowApproverRequest, DisableUserAutoSignRequest, UploadFilesRequest, CreateFileConvertTaskRequest, OperateSealsResponse, CancelUserAutoSignEnableUrlResponse, CreateContractDiffTaskWebUrlResponse, VerifyDigitFileRequest, CreateFlowEvidenceReportRequest, CreateBatchSignUrlResponse, DescribeUserAutoSignStatusResponse, DescribeContractReviewChecklistWebUrlResponse, CreateFlowForwardsResponse, DescribeFlowEvidenceReportRequest, ModifyPartnerAuthorizationResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, ModifySingleSignOnEmployeesResponse, CreateWebThemeConfigResponse, DescribeFlowInfoRequest, ArchiveDynamicFlowResponse, CreateLegalSealQrCodeRequest, DescribeSingleSignOnEmployeesRequest, CreateUserNameChangeUrlRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateBatchInformationExtractionTaskRequest, CreateFlowByFilesRequest, DescribeContractReviewChecklistRequest, OperateSealsRequest, DescribeFileUrlsResponse, CreateBatchAdminChangeInvitationsUrlResponse, CreateSingleSignOnEmployeesRequest, ModifyIntegrationRoleRequest, DescribeUserVerifyStatusRequest, CancelOrganizationFlowsRequest, VerifyPdfRequest, CreateEmployeeChangeUrlRequest, DescribeSingleSignOnEmployeesResponse, CreateUserAutoSignEnableUrlRequest, CreateBatchOrganizationRegistrationTasksRequest, CreateContractComparisonTaskRequest, DescribeBatchOrganizationRegistrationTasksResponse, CreatePrepareFlowResponse, DescribeOrganizationVerifyStatusRequest, CancelMultiFlowSignQRCodeRequest, CreateSealResponse, CreateFlowGroupRemindsRequest, VerifyDigitalDataSignRequest, DescribeIntegrationRolesResponse, ModifyExtendedServiceResponse, DescribeBillUsageDetailResponse, DescribeFlowBriefsResponse, DescribeRiskIdentificationTaskFeedbackRequest, CreateBatchAdminChangeInvitationsRequest, DescribeFlowTemplatesResponse, DescribePersonCertificateRequest, CreateBatchOrganizationAuthorizationUrlResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateIntegrationSubOrganizationActiveRecordRequest, CreateFileConvertTaskResponse, CreateOrganizationInfoChangeUrlRequest, DescribePersonCertificateResponse, CreateBatchAdminChangeInvitationsResponse, DescribeFileCounterSignResultRequest, CreateContractDiffTaskWebUrlRequest, DescribeContractReviewTaskRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, ModifyExtendedServiceRequest, CreateDraftContractByPromptsTaskRequest, CreateLMInformationExtractionTaskFieldFeedbackRequest, CreateContractReviewWebUrlResponse, DisableUserAutoSignResponse, DescribeContractReviewChecklistsWebUrlRequest, CreateContractComparisonTaskResponse, DescribeFileUrlsRequest, CreateMiniAppPrepareFlowResponse, ImportContractReviewChecklistResponse, CreateConvertTaskApiRequest, OperateTemplateRequest, CreateBatchQuickSignUrlResponse, CreateArchiveFlowTaskRequest, DeleteSingleSignOnEmployeesResponse, CreateUserMobileChangeUrlResponse, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateRiskIdentificationTaskFeedbackResponse, ExportContractReviewResultResponse, CreateBatchContractReviewTaskRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, CreateBatchInitOrganizationUrlRequest, DeleteOrganizationAuthorizationsResponse, CreateFlowForwardsRequest, CreateIntegrationDepartmentResponse, DeleteSealPoliciesResponse, DescribeOrganizationAuthStatusResponse, DescribeBatchOrganizationRegistrationTasksRequest, CreateSealPolicyResponse, CreateSchemeUrlResponse, CreateFlowSignUrlResponse, RenewAutoSignLicenseResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, VerifyDigitFileResponse, CreateContractReviewChecklistWebUrlResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreatePartnerAuthorizationLinkRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeContractReviewChecklistsWebUrlResponse, DescribeBillUsageResponse, ModifyIntegrationDepartmentRequest, CreateOrganizationBatchSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, CreatePartnerAuthorizationLinkResponse, CreateExtendedServiceAuthInfosResponse, DescribeDraftContractByPromptsTaskResponse, CreateOrganizationBatchSignUrlRequest, CreateDraftContractByPromptsTaskResponse, DeleteIntegrationDepartmentRequest, ExportContractReviewResultRequest, DescribeFileCounterSignResultResponse, CreateFlowGroupRemindsResponse, CreateBatchSignUrlRequest, CreateBatchInformationExtractionTaskResponse, DescribeContractComparisonTaskRequest, DescribeFlowBriefsRequest, CreateInformationExtractionWebUrlResponse, CreateFlowGroupSignReviewRequest, ExportContractComparisonTaskResponse, DescribeContractReviewChecklistResponse, DescribeContractReviewMarkedRiskExportTaskRequest, DescribeContractComparisonTaskResponse, DescribeArchiveFlowTaskRequest, CreateModifyAdminAuthorizationUrlResponse, CreateOrganizationInfoChangeUrlResponse, CreateFlowResponse, CreateUserNameChangeUrlResponse, ModifySingleSignOnEmployeesRequest, DeleteSingleSignOnEmployeesRequest, CancelMultiFlowSignQRCodeResponse, DescribeUserFlowTypeResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeIntegrationDepartmentsResponse, CreateFileCounterSignRequest, DescribeOrganizationVerifyStatusResponse, DeleteExtendedServiceAuthInfosResponse, DescribeEnterpriseContractReviewChecklistsResponse, ModifyApplicationCallbackInfoResponse, CreateUserVerifyUrlRequest, DescribeLMInformationExtractionTaskFieldFeedbackRequest, CreateIntegrationEmployeesRequest, DescribeContractDiffTaskWebUrlResponse, CreateOrganizationAuthUrlRequest, CreateIntegrationRoleRequest, CancelOrganizationFlowsResponse, DescribeIntegrationRolesRequest, CreateFlowGroupSignReviewResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFileConvertTaskRequest, DescribeBatchOrganizationRegistrationUrlsRequest, DescribeEnterpriseContractReviewChecklistsRequest, CreateDocumentResponse, CreateIntegrationUserRolesResponse, CreateEmbedWebUrlResponse, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ModifyPartnerAuthorizationRequest, CreateIntegrationSubOrganizationActiveRecordResponse, CreatePersonAuthCertificateImageResponse, DescribeLMInformationExtractionTaskFieldFeedbackResponse, CreateLMInformationExtractionTaskFieldFeedbackResponse, DescribeIntegrationEmployeesResponse, ModifyFlowDeadlineResponse, CreateBatchCancelFlowUrlResponse, CreateUserAutoSignEnableUrlResponse, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ModifyIntegrationRoleResponse, CreateSingleSignOnEmployeesResponse, CreateFlowEvidenceReportResponse, OperateTemplateResponse, CreateOrganizationGroupInvitationLinkResponse, DeleteIntegrationRoleUsersResponse, CreateFlowGroupByFilesRequest, CreatePreparedPersonalEsignResponse, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateArchiveFlowTaskResponse, CreateFlowSignReviewResponse, RenewAutoSignLicenseRequest, CreateWebThemeConfigRequest, CreateEmployeeQualificationSealQrCodeResponse, CreateUserVerifyUrlResponse, GetTaskResultApiResponse, CreatePrepareFlowGroupRequest, CreateFileCounterSignResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, DescribeContractReviewMarkedRiskExportTaskResponse, CreateSealPolicyRequest, DescribeContractReviewTaskResponse, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, UpdateIntegrationEmployeesRequest, CreateFlowGroupByTemplatesRequest, CreateBatchContractReviewTaskResponse, DescribeSignFaceVideoRequest, DescribeOrganizationSealsRequest, CreateBatchOrganizationAuthorizationUrlRequest, CreateDigitalDataSignRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DeleteExtendedServiceAuthInfosRequest, DescribeFlowInfoResponse, DescribeUserAutoSignStatusRequest, CreateFlowBlockchainEvidenceUrlRequest, CreateBatchQuickSignUrlRequest, DescribeExtendedServiceAuthInfosResponse, UpdateIntegrationEmployeesResponse, ModifyPartnerAutoSignAuthUrlRequest, DescribeInformationExtractionWebUrlResponse, CreateExtendedServiceAuthInfosRequest, CreatePrepareFlowGroupResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateBatchInitOrganizationUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateDigitalDataSignResponse, CreateOrganizationAuthFileResponse, StartFlowResponse, DescribeRiskIdentificationTaskFeedbackResponse, DescribeInformationExtractionWebUrlRequest, DescribeFlowComponentsResponse, DescribeContractReviewWebUrlResponse, OperateFlowRemarksResponse, DescribeIntegrationEmployeesRequest, DescribeContractReviewTaskListWebUrlResponse, CreateFlowRequest, CreateContractReviewWebUrlRequest, CreateDynamicFlowApproverResponse, CreateBatchOrganizationRegistrationTasksResponse, DescribeOrganizationSealsResponse, DescribeBillUsageDetailRequest, CreateBatchAdminChangeInvitationsUrlRequest, CreateUserAutoSignSealUrlResponse, CreateEmployeeQualificationSealQrCodeRequest, OperateFlowRemarksRequest, DescribeInformationExtractionTaskResponse, CreateEmployeeChangeUrlResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateOrganizationAuthUrlResponse, DescribeOrganizationAuthStatusRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ExportContractComparisonTaskRequest, CreatePreparedPersonalEsignRequest, ImportContractReviewChecklistRequest, CreateMiniAppPrepareFlowRequest, CreateIntegrationDepartmentRequest, CreateFlowBlockchainEvidenceUrlResponse, CreateDocumentRequest, CreateContractReviewChecklistWebUrlRequest, CreateUserMobileChangeUrlRequest, CreateEmbedWebUrlRequest, ExportContractReviewMarkedRiskResponse, CreateFlowGroupByFilesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, DescribeFileConvertTaskResponse, VerifyDigitalDataSignResponse, CreateModifyAdminAuthorizationUrlRequest, DeleteOrganizationAuthorizationsRequest, CancelUserAutoSignEnableUrlRequest, DescribeUserVerifyStatusResponse, ExportContractReviewMarkedRiskRequest, DescribeArchiveFlowTaskResponse, DescribeBillUsageRequest, ModifyApplicationCallbackInfoRequest, DescribeContractDiffTaskWebUrlRequest, StartFlowRequest, DeleteIntegrationEmployeesResponse, DescribeContractReviewChecklistWebUrlRequest, CreateFlowRemindsRequest, DescribeDraftContractByPromptsTaskRequest, DescribeSignFaceVideoResponse, VerifyPdfResponse, DescribeBatchOrganizationRegistrationUrlsResponse, CreateInformationExtractionWebUrlRequest, CreateRiskIdentificationTaskFeedbackRequest, DescribeUserFlowTypeRequest, DescribeContractReviewTaskListWebUrlRequest, DescribeOrganizationGroupOrganizationsResponse } from "./ess_models";
3
+ import { CreateOrganizationGroupInvitationLinkRequest, DescribeCancelFlowsTaskResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeContractReviewWebUrlRequest, DescribeInformationExtractionTaskRequest, CreateDynamicFlowApproverRequest, DisableUserAutoSignRequest, UploadFilesRequest, CreateFileConvertTaskRequest, OperateSealsResponse, CancelUserAutoSignEnableUrlResponse, CreateContractDiffTaskWebUrlResponse, VerifyDigitFileRequest, CreateFlowEvidenceReportRequest, CreateBatchSignUrlResponse, DescribeUserAutoSignStatusResponse, DescribeContractReviewChecklistWebUrlResponse, CreateFlowForwardsResponse, DescribeFlowEvidenceReportRequest, ModifyPartnerAuthorizationResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, ModifySingleSignOnEmployeesResponse, CreateWebThemeConfigResponse, DescribeFlowInfoRequest, ArchiveDynamicFlowResponse, CreateLegalSealQrCodeRequest, DescribeSingleSignOnEmployeesRequest, CreateUserNameChangeUrlRequest, CreateRequestWithEncryptionRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateBatchInformationExtractionTaskRequest, CreateFlowByFilesRequest, DescribeContractReviewChecklistRequest, OperateSealsRequest, DescribeFileUrlsResponse, CreateBatchAdminChangeInvitationsUrlResponse, CreateSingleSignOnEmployeesRequest, ModifyIntegrationRoleRequest, DescribeUserVerifyStatusRequest, CancelOrganizationFlowsRequest, VerifyPdfRequest, CreateEmployeeChangeUrlRequest, DescribeSingleSignOnEmployeesResponse, CreateUserAutoSignEnableUrlRequest, CreateBatchOrganizationRegistrationTasksRequest, CreateContractComparisonTaskRequest, DescribeBatchOrganizationRegistrationTasksResponse, CreatePrepareFlowResponse, DescribeOrganizationVerifyStatusRequest, CancelMultiFlowSignQRCodeRequest, CreateSealResponse, CreateFlowGroupRemindsRequest, VerifyDigitalDataSignRequest, DescribeIntegrationRolesResponse, ModifyExtendedServiceResponse, DescribeBillUsageDetailResponse, DescribeFlowBriefsResponse, DescribeRiskIdentificationTaskFeedbackRequest, CreateBatchAdminChangeInvitationsRequest, DescribeFlowTemplatesResponse, DescribePersonCertificateRequest, CreateBatchOrganizationAuthorizationUrlResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateIntegrationSubOrganizationActiveRecordRequest, CreateFileConvertTaskResponse, CreateOrganizationInfoChangeUrlRequest, DescribePersonCertificateResponse, CreateBatchAdminChangeInvitationsResponse, DescribeFileCounterSignResultRequest, CreateContractDiffTaskWebUrlRequest, DescribeContractReviewTaskRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, ModifyExtendedServiceRequest, CreateDraftContractByPromptsTaskRequest, CreateLMInformationExtractionTaskFieldFeedbackRequest, CreateContractReviewWebUrlResponse, DisableUserAutoSignResponse, DescribeContractReviewChecklistsWebUrlRequest, CreateContractComparisonTaskResponse, DescribeFileUrlsRequest, CreateMiniAppPrepareFlowResponse, ImportContractReviewChecklistResponse, CreateConvertTaskApiRequest, OperateTemplateRequest, CreateBatchQuickSignUrlResponse, CreateArchiveFlowTaskRequest, DeleteSingleSignOnEmployeesResponse, CreateUserMobileChangeUrlResponse, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateRiskIdentificationTaskFeedbackResponse, ExportContractReviewResultResponse, CreateBatchContractReviewTaskRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, CreateBatchInitOrganizationUrlRequest, DeleteOrganizationAuthorizationsResponse, CreateFlowForwardsRequest, CreateIntegrationDepartmentResponse, DeleteSealPoliciesResponse, DescribeOrganizationAuthStatusResponse, DescribeBatchOrganizationRegistrationTasksRequest, CreateSealPolicyResponse, CreateSchemeUrlResponse, CreateFlowSignUrlResponse, RenewAutoSignLicenseResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, VerifyDigitFileResponse, CreateContractReviewChecklistWebUrlResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreatePartnerAuthorizationLinkRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeContractReviewChecklistsWebUrlResponse, DescribeBillUsageResponse, ModifyIntegrationDepartmentRequest, CreateOrganizationBatchSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, CreatePartnerAuthorizationLinkResponse, CreateExtendedServiceAuthInfosResponse, DescribeDraftContractByPromptsTaskResponse, CreateOrganizationBatchSignUrlRequest, CreateDraftContractByPromptsTaskResponse, DeleteIntegrationDepartmentRequest, ExportContractReviewResultRequest, DescribeFileCounterSignResultResponse, CreateFlowGroupRemindsResponse, CreateBatchSignUrlRequest, CreateBatchInformationExtractionTaskResponse, DescribeContractComparisonTaskRequest, DescribeFlowBriefsRequest, CreateInformationExtractionWebUrlResponse, CreateFlowGroupSignReviewRequest, ExportContractComparisonTaskResponse, DescribeContractReviewChecklistResponse, DescribeContractReviewMarkedRiskExportTaskRequest, DescribeContractComparisonTaskResponse, DescribeArchiveFlowTaskRequest, CreateModifyAdminAuthorizationUrlResponse, CreateOrganizationInfoChangeUrlResponse, CreateFlowResponse, CreateUserNameChangeUrlResponse, ModifySingleSignOnEmployeesRequest, DeleteSingleSignOnEmployeesRequest, CancelMultiFlowSignQRCodeResponse, DescribeUserFlowTypeResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeIntegrationDepartmentsResponse, CreateFileCounterSignRequest, DescribeOrganizationVerifyStatusResponse, DeleteExtendedServiceAuthInfosResponse, DescribeEnterpriseContractReviewChecklistsResponse, ModifyApplicationCallbackInfoResponse, CreateUserVerifyUrlRequest, DescribeLMInformationExtractionTaskFieldFeedbackRequest, CreateIntegrationEmployeesRequest, DescribeContractDiffTaskWebUrlResponse, CreateOrganizationAuthUrlRequest, CreateIntegrationRoleRequest, CancelOrganizationFlowsResponse, DescribeIntegrationRolesRequest, CreateFlowGroupSignReviewResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFileConvertTaskRequest, DescribeBatchOrganizationRegistrationUrlsRequest, DescribeEnterpriseContractReviewChecklistsRequest, CreateDocumentResponse, CreateIntegrationUserRolesResponse, CreateEmbedWebUrlResponse, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ModifyPartnerAuthorizationRequest, CreateIntegrationSubOrganizationActiveRecordResponse, CreatePersonAuthCertificateImageResponse, DescribeLMInformationExtractionTaskFieldFeedbackResponse, CreateLMInformationExtractionTaskFieldFeedbackResponse, DescribeIntegrationEmployeesResponse, ModifyFlowDeadlineResponse, CreateBatchCancelFlowUrlResponse, CreateUserAutoSignEnableUrlResponse, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ModifyIntegrationRoleResponse, CreateSingleSignOnEmployeesResponse, CreateFlowEvidenceReportResponse, OperateTemplateResponse, CreateOrganizationGroupInvitationLinkResponse, DeleteIntegrationRoleUsersResponse, CreateFlowGroupByFilesRequest, CreatePreparedPersonalEsignResponse, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateArchiveFlowTaskResponse, CreateFlowSignReviewResponse, RenewAutoSignLicenseRequest, CreateWebThemeConfigRequest, CreateEmployeeQualificationSealQrCodeResponse, CreateUserVerifyUrlResponse, GetTaskResultApiResponse, CreatePrepareFlowGroupRequest, CreateFileCounterSignResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, DescribeContractReviewMarkedRiskExportTaskResponse, CreateSealPolicyRequest, DescribeContractReviewTaskResponse, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, UpdateIntegrationEmployeesRequest, CreateFlowGroupByTemplatesRequest, CreateBatchContractReviewTaskResponse, DescribeSignFaceVideoRequest, DescribeOrganizationSealsRequest, CreateBatchOrganizationAuthorizationUrlRequest, CreateDigitalDataSignRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DeleteExtendedServiceAuthInfosRequest, DescribeFlowInfoResponse, DescribeUserAutoSignStatusRequest, CreateFlowBlockchainEvidenceUrlRequest, CreateBatchQuickSignUrlRequest, DescribeExtendedServiceAuthInfosResponse, UpdateIntegrationEmployeesResponse, ModifyPartnerAutoSignAuthUrlRequest, DescribeInformationExtractionWebUrlResponse, CreateExtendedServiceAuthInfosRequest, CreatePrepareFlowGroupResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateBatchInitOrganizationUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateDigitalDataSignResponse, CreateOrganizationAuthFileResponse, StartFlowResponse, DescribeRiskIdentificationTaskFeedbackResponse, DescribeInformationExtractionWebUrlRequest, DescribeFlowComponentsResponse, DescribeContractReviewWebUrlResponse, OperateFlowRemarksResponse, CreateRequestWithEncryptionResponse, DescribeIntegrationEmployeesRequest, DescribeContractReviewTaskListWebUrlResponse, CreateFlowRequest, CreateContractReviewWebUrlRequest, CreateDynamicFlowApproverResponse, CreateBatchOrganizationRegistrationTasksResponse, DescribeOrganizationSealsResponse, DescribeBillUsageDetailRequest, CreateBatchAdminChangeInvitationsUrlRequest, CreateUserAutoSignSealUrlResponse, CreateEmployeeQualificationSealQrCodeRequest, OperateFlowRemarksRequest, DescribeInformationExtractionTaskResponse, CreateEmployeeChangeUrlResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateOrganizationAuthUrlResponse, DescribeOrganizationAuthStatusRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ExportContractComparisonTaskRequest, CreatePreparedPersonalEsignRequest, ImportContractReviewChecklistRequest, CreateMiniAppPrepareFlowRequest, CreateIntegrationDepartmentRequest, CreateFlowBlockchainEvidenceUrlResponse, CreateDocumentRequest, CreateContractReviewChecklistWebUrlRequest, CreateUserMobileChangeUrlRequest, CreateEmbedWebUrlRequest, ExportContractReviewMarkedRiskResponse, CreateFlowGroupByFilesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, DescribeFileConvertTaskResponse, VerifyDigitalDataSignResponse, CreateModifyAdminAuthorizationUrlRequest, DeleteOrganizationAuthorizationsRequest, CancelUserAutoSignEnableUrlRequest, DescribeUserVerifyStatusResponse, ExportContractReviewMarkedRiskRequest, DescribeArchiveFlowTaskResponse, DescribeBillUsageRequest, ModifyApplicationCallbackInfoRequest, DescribeContractDiffTaskWebUrlRequest, StartFlowRequest, DeleteIntegrationEmployeesResponse, DescribeContractReviewChecklistWebUrlRequest, CreateFlowRemindsRequest, DescribeDraftContractByPromptsTaskRequest, DescribeSignFaceVideoResponse, VerifyPdfResponse, DescribeBatchOrganizationRegistrationUrlsResponse, CreateInformationExtractionWebUrlRequest, CreateRiskIdentificationTaskFeedbackRequest, DescribeUserFlowTypeRequest, DescribeContractReviewTaskListWebUrlRequest, DescribeOrganizationGroupOrganizationsResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -925,6 +925,124 @@ export declare class Client extends AbstractClient {
925
925
  5. <font color="red">操作链接过期时间默认为生成链接后7天。</font>
926
926
  */
927
927
  CreateBatchInitOrganizationUrl(req: CreateBatchInitOrganizationUrlRequest, cb?: (error: string, rep: CreateBatchInitOrganizationUrlResponse) => void): Promise<CreateBatchInitOrganizationUrlResponse>;
928
+ /**
929
+ * 该接口支持对请求内容进行加密传输。调用方需使用约定的 AES-CBC 或 SM4-CBC 算法对请求内容进行加密,并使用 HMAC-SHA256 或 HMAC-SM3 算法对 IV 和加密后的数据进行完整性校验,防止请求内容被篡改。
930
+
931
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/391df0a37c2b213445c4909ba98824ac.svg)
932
+
933
+ **请求端加密流程**
934
+ 1. 每次请求使用密码学安全的随机源生成 16 字节 的 IV。每次请求必须重新生成,严禁复用。
935
+ 2. 使用约定的 AES-CBC 或 SM4-CBC 算法对原始请求体进行加密,使用 PKCS#7 Padding。
936
+ 3. 将加密后的密文原始字节进行标准 Base64 编码,作为 EncryptedData 参数。
937
+ 4. 将 IV 原始字节进行标准 Base64 编码,作为 IV 参数。
938
+ 5. 对 IV 原始字节和密文原始字节直接拼接(不添加分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)
939
+ 6. 将 HMAC 的结果进行 标准 Base64 编码,作为 EncryptionSignature 参数。
940
+
941
+ **响应端解密流程**
942
+ 1. 先判断本接口自身是否返回外层错误,此时错误为明文(标准腾讯云错误体),有则直接失败处理。
943
+ 2. 分别对 IV、EncryptedData、EncryptionSignature 做标准 Base64 解码,得到原始字节。
944
+ 3. 将 IV 与密文原始字节直接拼接(无分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)。
945
+ 4. 与响应中 EncryptionSignature 解码后的字节做恒定时间比较,不一致立即失败,不得继续解密。
946
+ 5. 使用约定的 AES-CBC 或 SM4-CBC,以 IV 和密钥解密 EncryptedData,去除 PKCS#7 Padding 得到明文。
947
+ 6. 先用腾讯云标准错误体反序列化明文,判断被加密业务接口是否返回 Error。
948
+ 7. 无业务错误时,再用目标业务接口的响应结构体反序列化明文,取出实际业务参数。
949
+
950
+ **响应端错误处理**
951
+ 1. 外层错误(本接口本身调用失败):返回标准腾讯云错误 JSON(含 Error.Code / Error.Message),无 EncryptedData,不需要解密即可处理。
952
+ 2. 内层错误(业务接口执行失败):外层成功,但解密后的明文里包含 Error.Code / Error.Message,按目标业务接口的错误规范处理。
953
+
954
+ **处理过程示例**
955
+ ```
956
+ # ========== 前置约定 ==========
957
+ AESKey : 加密 密钥(AES 32 字节,SM4 16 字节)
958
+ HMACKey : HMAC 密钥(与加密密钥需要不同)
959
+ ALGO : AES-CBC 或 SM4-CBC,双方约定
960
+ HMAC : ALGO == AES-CBC ? HMAC-SHA256 : HMAC-SM3
961
+
962
+ # ========== 请求端:加密并调用 ==========
963
+ function CallWithEncryption(bizAction, bizRequestObj):
964
+ # 1. 序列化业务请求
965
+ plaintext = JSON.stringify(bizRequestObj)
966
+ # 2. 生成 16 字节随机 IV(每次新生成,禁止复用)
967
+ iv = SecureRandom(16)
968
+ # 3. 对称加密(PKCS#7 Padding)
969
+ ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
970
+ # 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
971
+ signature = HMAC(HMACKey, concat(iv, ciphertext))
972
+ # 5. 组装外层请求参数(三段均为标准 Base64)
973
+ encReq = {
974
+ RequestAction: bizAction,
975
+ IV: Base64(iv),
976
+ EncryptedData: Base64(ciphertext),
977
+ EncryptionSignature: Base64(signature),
978
+ }
979
+ # 6. 调用 CreateRequestWithEncryption
980
+ # TC3-HMAC-SHA256 鉴权由官方 SDK 自动完成
981
+ encResp = CloudAPI.CreateRequestWithEncryption(encReq)
982
+ # 7. 外层错误:明文,直接抛出
983
+ if encResp.Error != nil:
984
+ raise OuterError(encResp.Error)
985
+ # 8. 解密并返回业务响应
986
+ return DecryptResponse(encResp.Response)
987
+
988
+ # ========== 响应端:校验并解密 ==========
989
+ function DecryptResponse(resp):
990
+ # 1. Base64 解码
991
+ ivBytes = Base64Decode(resp.IV)
992
+ ctBytes = Base64Decode(resp.EncryptedData)
993
+ sigBytes = Base64Decode(resp.EncryptionSignature)
994
+ # 2. 重新计算 HMAC
995
+ expected = HMAC(HMACKey, concat(ivBytes, ctBytes))
996
+ # 3. 恒定时间比较,失败立即终止(不得继续解密)
997
+ if not ConstantTimeEqual(expected, sigBytes):
998
+ raise SignatureMismatch
999
+ # 4. 对称解密,去除 PKCS#7 Padding
1000
+ plaintext = SymmetricDecrypt(ALGO, AESKey, ivBytes, ctBytes)
1001
+ # 5. 先按腾讯云错误体解析,判断业务是否失败
1002
+ bizErr = TryParseTencentCloudError(plaintext)
1003
+ if bizErr != nil:
1004
+ raise BusinessError(bizErr)
1005
+ # 6. 按目标业务接口的响应结构反序列化
1006
+ return JSON.parse(plaintext, BizResponseSchema)
1007
+ ```
1008
+
1009
+ **AES-CBC 示例**
1010
+ 以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
1011
+
1012
+ 加密密钥:AES-CBC-Key-1234
1013
+ 签名密钥:AES-HMAC-Key-123
1014
+ IV:1234567890abcdef
1015
+ 请求内容:{"Request": "This is a test."}
1016
+
1017
+ 最终请求参数:
1018
+ ```
1019
+ {
1020
+ "RequestAction": "DescribeFlowComponents",
1021
+ "IV": "MTIzNDU2Nzg5MGFiY2RlZg==",
1022
+ "EncryptedData": "Iqp2W1jislwMNmE7bH9dKZZiMQsfkAPyvAAqDFRnWLw=",
1023
+ "EncryptionSignature": "4TT3PUCZgZT7YmEPtXDm5PDcM6xT7FoYHfMW8xunB5I="
1024
+ }
1025
+ ```
1026
+
1027
+ **SM4-CBC 示例**
1028
+ 以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
1029
+
1030
+ 加密密钥:SM4-CBC-Key-1234
1031
+ 签名密钥:SM4-HMAC-Key-123
1032
+ IV:fedcba0987654321
1033
+ 请求内容:{"Request": "This is a test."}
1034
+
1035
+ 最终请求参数:
1036
+ ```
1037
+ {
1038
+ "RequestAction": "DescribeFlowComponents",
1039
+ "IV": "ZmVkY2JhMDk4NzY1NDMyMQ==",
1040
+ "EncryptedData": "GwUovQhNUPaUnVM/UDXMtPOYTpTSi2B1oyZDFbyyvns=",
1041
+ "EncryptionSignature": "nHB/v/AvOaDCQ66esFNnp12lHKcGkwaLGid0Warl/KE="
1042
+ }
1043
+ ```
1044
+ */
1045
+ CreateRequestWithEncryption(req: CreateRequestWithEncryptionRequest, cb?: (error: string, rep: CreateRequestWithEncryptionResponse) => void): Promise<CreateRequestWithEncryptionResponse>;
928
1046
  /**
929
1047
  * 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接,撤销生成的链接失效。
930
1048
 
@@ -1097,6 +1097,126 @@ class Client extends abstract_client_1.AbstractClient {
1097
1097
  async CreateBatchInitOrganizationUrl(req, cb) {
1098
1098
  return this.request("CreateBatchInitOrganizationUrl", req, cb);
1099
1099
  }
1100
+ /**
1101
+ * 该接口支持对请求内容进行加密传输。调用方需使用约定的 AES-CBC 或 SM4-CBC 算法对请求内容进行加密,并使用 HMAC-SHA256 或 HMAC-SM3 算法对 IV 和加密后的数据进行完整性校验,防止请求内容被篡改。
1102
+
1103
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/391df0a37c2b213445c4909ba98824ac.svg)
1104
+
1105
+ **请求端加密流程**
1106
+ 1. 每次请求使用密码学安全的随机源生成 16 字节 的 IV。每次请求必须重新生成,严禁复用。
1107
+ 2. 使用约定的 AES-CBC 或 SM4-CBC 算法对原始请求体进行加密,使用 PKCS#7 Padding。
1108
+ 3. 将加密后的密文原始字节进行标准 Base64 编码,作为 EncryptedData 参数。
1109
+ 4. 将 IV 原始字节进行标准 Base64 编码,作为 IV 参数。
1110
+ 5. 对 IV 原始字节和密文原始字节直接拼接(不添加分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)
1111
+ 6. 将 HMAC 的结果进行 标准 Base64 编码,作为 EncryptionSignature 参数。
1112
+
1113
+ **响应端解密流程**
1114
+ 1. 先判断本接口自身是否返回外层错误,此时错误为明文(标准腾讯云错误体),有则直接失败处理。
1115
+ 2. 分别对 IV、EncryptedData、EncryptionSignature 做标准 Base64 解码,得到原始字节。
1116
+ 3. 将 IV 与密文原始字节直接拼接(无分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)。
1117
+ 4. 与响应中 EncryptionSignature 解码后的字节做恒定时间比较,不一致立即失败,不得继续解密。
1118
+ 5. 使用约定的 AES-CBC 或 SM4-CBC,以 IV 和密钥解密 EncryptedData,去除 PKCS#7 Padding 得到明文。
1119
+ 6. 先用腾讯云标准错误体反序列化明文,判断被加密业务接口是否返回 Error。
1120
+ 7. 无业务错误时,再用目标业务接口的响应结构体反序列化明文,取出实际业务参数。
1121
+
1122
+ **响应端错误处理**
1123
+ 1. 外层错误(本接口本身调用失败):返回标准腾讯云错误 JSON(含 Error.Code / Error.Message),无 EncryptedData,不需要解密即可处理。
1124
+ 2. 内层错误(业务接口执行失败):外层成功,但解密后的明文里包含 Error.Code / Error.Message,按目标业务接口的错误规范处理。
1125
+
1126
+ **处理过程示例**
1127
+ ```
1128
+ # ========== 前置约定 ==========
1129
+ AESKey : 加密 密钥(AES 32 字节,SM4 16 字节)
1130
+ HMACKey : HMAC 密钥(与加密密钥需要不同)
1131
+ ALGO : AES-CBC 或 SM4-CBC,双方约定
1132
+ HMAC : ALGO == AES-CBC ? HMAC-SHA256 : HMAC-SM3
1133
+
1134
+ # ========== 请求端:加密并调用 ==========
1135
+ function CallWithEncryption(bizAction, bizRequestObj):
1136
+ # 1. 序列化业务请求
1137
+ plaintext = JSON.stringify(bizRequestObj)
1138
+ # 2. 生成 16 字节随机 IV(每次新生成,禁止复用)
1139
+ iv = SecureRandom(16)
1140
+ # 3. 对称加密(PKCS#7 Padding)
1141
+ ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
1142
+ # 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
1143
+ signature = HMAC(HMACKey, concat(iv, ciphertext))
1144
+ # 5. 组装外层请求参数(三段均为标准 Base64)
1145
+ encReq = {
1146
+ RequestAction: bizAction,
1147
+ IV: Base64(iv),
1148
+ EncryptedData: Base64(ciphertext),
1149
+ EncryptionSignature: Base64(signature),
1150
+ }
1151
+ # 6. 调用 CreateRequestWithEncryption
1152
+ # TC3-HMAC-SHA256 鉴权由官方 SDK 自动完成
1153
+ encResp = CloudAPI.CreateRequestWithEncryption(encReq)
1154
+ # 7. 外层错误:明文,直接抛出
1155
+ if encResp.Error != nil:
1156
+ raise OuterError(encResp.Error)
1157
+ # 8. 解密并返回业务响应
1158
+ return DecryptResponse(encResp.Response)
1159
+
1160
+ # ========== 响应端:校验并解密 ==========
1161
+ function DecryptResponse(resp):
1162
+ # 1. Base64 解码
1163
+ ivBytes = Base64Decode(resp.IV)
1164
+ ctBytes = Base64Decode(resp.EncryptedData)
1165
+ sigBytes = Base64Decode(resp.EncryptionSignature)
1166
+ # 2. 重新计算 HMAC
1167
+ expected = HMAC(HMACKey, concat(ivBytes, ctBytes))
1168
+ # 3. 恒定时间比较,失败立即终止(不得继续解密)
1169
+ if not ConstantTimeEqual(expected, sigBytes):
1170
+ raise SignatureMismatch
1171
+ # 4. 对称解密,去除 PKCS#7 Padding
1172
+ plaintext = SymmetricDecrypt(ALGO, AESKey, ivBytes, ctBytes)
1173
+ # 5. 先按腾讯云错误体解析,判断业务是否失败
1174
+ bizErr = TryParseTencentCloudError(plaintext)
1175
+ if bizErr != nil:
1176
+ raise BusinessError(bizErr)
1177
+ # 6. 按目标业务接口的响应结构反序列化
1178
+ return JSON.parse(plaintext, BizResponseSchema)
1179
+ ```
1180
+
1181
+ **AES-CBC 示例**
1182
+ 以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
1183
+
1184
+ 加密密钥:AES-CBC-Key-1234
1185
+ 签名密钥:AES-HMAC-Key-123
1186
+ IV:1234567890abcdef
1187
+ 请求内容:{"Request": "This is a test."}
1188
+
1189
+ 最终请求参数:
1190
+ ```
1191
+ {
1192
+ "RequestAction": "DescribeFlowComponents",
1193
+ "IV": "MTIzNDU2Nzg5MGFiY2RlZg==",
1194
+ "EncryptedData": "Iqp2W1jislwMNmE7bH9dKZZiMQsfkAPyvAAqDFRnWLw=",
1195
+ "EncryptionSignature": "4TT3PUCZgZT7YmEPtXDm5PDcM6xT7FoYHfMW8xunB5I="
1196
+ }
1197
+ ```
1198
+
1199
+ **SM4-CBC 示例**
1200
+ 以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
1201
+
1202
+ 加密密钥:SM4-CBC-Key-1234
1203
+ 签名密钥:SM4-HMAC-Key-123
1204
+ IV:fedcba0987654321
1205
+ 请求内容:{"Request": "This is a test."}
1206
+
1207
+ 最终请求参数:
1208
+ ```
1209
+ {
1210
+ "RequestAction": "DescribeFlowComponents",
1211
+ "IV": "ZmVkY2JhMDk4NzY1NDMyMQ==",
1212
+ "EncryptedData": "GwUovQhNUPaUnVM/UDXMtPOYTpTSi2B1oyZDFbyyvns=",
1213
+ "EncryptionSignature": "nHB/v/AvOaDCQ66esFNnp12lHKcGkwaLGid0Warl/KE="
1214
+ }
1215
+ ```
1216
+ */
1217
+ async CreateRequestWithEncryption(req, cb) {
1218
+ return this.request("CreateRequestWithEncryption", req, cb);
1219
+ }
1100
1220
  /**
1101
1221
  * 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接,撤销生成的链接失效。
1102
1222
 
@@ -1099,6 +1099,27 @@ export interface AuthRecord {
1099
1099
  */
1100
1100
  Reason?: string;
1101
1101
  }
1102
+ /**
1103
+ * CreateRequestWithEncryption请求参数结构体
1104
+ */
1105
+ export interface CreateRequestWithEncryptionRequest {
1106
+ /**
1107
+ * <p>操作的接口名称。取值参考接口文档输入参数章节关于公共参数 Action 的说明。</p>
1108
+ */
1109
+ RequestAction: string;
1110
+ /**
1111
+ * <p>加密算法使用的初始化向量。固定为 16 字节,将 IV 原始字节使用标准 Base64 编码后传入。</p>
1112
+ */
1113
+ IV: string;
1114
+ /**
1115
+ * <p>使用 AES-CBC 或 SM4-CBC 加密请求内容得到的密文。加密前请求内容采用 PKCS#7 Padding;将密文原始字节使用标准 Base64 编码后传入。</p>
1116
+ */
1117
+ EncryptedData: string;
1118
+ /**
1119
+ * <p>用于校验请求数据完整性。对 IV 原始字节和密文原始字节直接拼接(不加拼接符)后计算 HMAC-SHA256,再将计算结果使用标准 Base64 编码后传入。</p>
1120
+ */
1121
+ EncryptionSignature?: string;
1122
+ }
1102
1123
  /**
1103
1124
  * UnbindEmployeeUserIdWithClientOpenId请求参数结构体
1104
1125
  */
@@ -10893,6 +10914,27 @@ export interface OperateFlowRemarksResponse {
10893
10914
  */
10894
10915
  RequestId?: string;
10895
10916
  }
10917
+ /**
10918
+ * CreateRequestWithEncryption返回参数结构体
10919
+ */
10920
+ export interface CreateRequestWithEncryptionResponse {
10921
+ /**
10922
+ * <p>加密算法使用的初始化向量。固定为 16 字节,将 IV 原始字节使用标准 Base64 编码后传入。</p>
10923
+ */
10924
+ IV?: string;
10925
+ /**
10926
+ * <p>使用 AES-CBC 或 SM4-CBC 加密返回内容得到的密文。加密前返回内容采用 PKCS#7 Padding;将密文原始字节使用标准 Base64 编码后传入。</p>
10927
+ */
10928
+ EncryptedData?: string;
10929
+ /**
10930
+ * <p>用于校验请求数据完整性。对 IV 原始字节和密文原始字节直接拼接(不加拼接符)后计算 HMAC-SHA256,再将计算结果使用标准 Base64 编码后传入。</p>
10931
+ */
10932
+ EncryptionSignature?: string;
10933
+ /**
10934
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10935
+ */
10936
+ RequestId?: string;
10937
+ }
10896
10938
  /**
10897
10939
  * DescribeIntegrationEmployees请求参数结构体
10898
10940
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, CreateBatchAdminChangeInvitationsResponse, ChannelCreateFlowRemindsResponse, DescribeUserFlowTypeResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDescribeSignFaceVideoRequest, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeCancelFlowsTaskResponse, CreateEmployeeQualificationSealQrCodeResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, CreateFlowForwardsRequest, DescribeFlowDetailInfoRequest, ChannelCancelFlowResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateFileConvertTaskRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, DescribeFileConvertTaskResponse, ChannelCreateBatchSignUrlResponse, CreateBatchAdminChangeInvitationsUrlRequest, ChannelCreatePrepareFlowResponse, CreateBatchInitOrganizationUrlResponse, OperateChannelTemplateResponse, ChannelCreateDynamicFlowApproverResponse, ChannelCreateRoleRequest, CreateOrganizationAuthFileResponse, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, ChannelCreatePrepareFlowRequest, ChannelCreateFlowSignUrlRequest, ChannelCreateSealPolicyResponse, OperateTemplateRequest, ChannelDescribeSignFaceVideoResponse, ChannelCancelUserAutoSignEnableUrlResponse, ChannelCreateWebThemeConfigRequest, CancelOrganizationFlowsResponse, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, DescribeFileConvertTaskRequest, ChannelCreateOrganizationModifyQrCodeRequest, CreateChannelSubOrganizationActiveRequest, ChannelRenewAutoSignLicenseResponse, ModifyOrganizationBusinessInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, DeleteOrganizationAuthorizationsResponse, ChannelCreatePrepareFlowGroupRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ChannelVerifyPdfResponse, ArchiveDynamicFlowResponse, CreateConsoleLoginUrlRequest, CreateLegalSealQrCodeRequest, CreateCloseOrganizationUrlRequest, CreatePersonAuthCertificateImageResponse, ModifyPartnerAutoSignAuthUrlRequest, CreateEmployeeQualificationSealQrCodeRequest, DescribeBatchOrganizationRegistrationTasksRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, CreateCloseOrganizationUrlResponse, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ChannelCreateDynamicFlowApproverRequest, ModifyFlowDeadlineResponse, DescribeFlowDetailInfoResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, OperateTemplateResponse, CreateFlowBlockchainEvidenceUrlResponse, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateBatchAdminChangeInvitationsUrlResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelDescribeBillUsageDetailResponse, CreateEmployeeChangeUrlResponse, ChannelRenewAutoSignLicenseRequest, ChannelCreatePreparedPersonalEsignRequest, CancelOrganizationFlowsRequest, CreatePersonAuthCertificateImageRequest, PrepareFlowsRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, CreateEmployeeChangeUrlRequest, ChannelDescribeUserAutoSignStatusRequest, CreateModifyAdminAuthorizationUrlRequest, ChannelModifyRoleResponse, ModifyOrganizationBusinessInfoRequest, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreateBatchOrganizationAuthorizationUrlResponse, CreatePartnerAutoSignAuthUrlRequest, DescribeBatchOrganizationRegistrationTasksResponse, ChannelCreateBatchCancelFlowUrlRequest, ChannelDescribeAccountBillDetailResponse, CreateFlowForwardsResponse, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, CreateChannelSubOrganizationActiveResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, DeleteOrganizationAuthorizationsRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreatePrepareFlowGroupResponse, DescribeCancelFlowsTaskRequest, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelUpdateSealStatusResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateBatchInitOrganizationUrlRequest, CreateFlowGroupSignReviewRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateBatchAdminChangeInvitationsRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, CreateSealByImageRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, CreateBatchOrganizationAuthorizationUrlRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeAccountBillDetailRequest, ChannelDescribeEmployeesResponse, CreateModifyAdminAuthorizationUrlResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, SyncProxyOrganizationRequest, DescribeChannelFlowEvidenceReportResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateFlowBlockchainEvidenceUrlRequest, DescribeUserFlowTypeRequest, ChannelCreateFlowApproversRequest, ChannelDescribeBillUsageDetailRequest, ChannelCreateFlowRemindsRequest, DescribeExtendedServiceAuthInfoResponse, CreateFileConvertTaskResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, CreateBatchAdminChangeInvitationsResponse, ChannelCreateFlowRemindsResponse, DescribeUserFlowTypeResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDescribeSignFaceVideoRequest, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeCancelFlowsTaskResponse, CreateEmployeeQualificationSealQrCodeResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, CreateFlowForwardsRequest, DescribeFlowDetailInfoRequest, ChannelCancelFlowResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateFileConvertTaskRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, DescribeFileConvertTaskResponse, ChannelCreateBatchSignUrlResponse, CreateBatchAdminChangeInvitationsUrlRequest, ChannelCreatePrepareFlowResponse, CreateBatchInitOrganizationUrlResponse, OperateChannelTemplateResponse, ChannelCreateDynamicFlowApproverResponse, ChannelCreateRoleRequest, CreateOrganizationAuthFileResponse, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, ChannelCreatePrepareFlowRequest, ChannelCreateFlowSignUrlRequest, ChannelCreateSealPolicyResponse, OperateTemplateRequest, ChannelDescribeSignFaceVideoResponse, ChannelCancelUserAutoSignEnableUrlResponse, ChannelCreateWebThemeConfigRequest, CancelOrganizationFlowsResponse, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, DescribeFileConvertTaskRequest, ChannelCreateOrganizationModifyQrCodeRequest, CreateChannelSubOrganizationActiveRequest, ChannelRenewAutoSignLicenseResponse, ModifyOrganizationBusinessInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, CreateRequestWithEncryptionResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, DeleteOrganizationAuthorizationsResponse, ChannelCreatePrepareFlowGroupRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ChannelVerifyPdfResponse, ArchiveDynamicFlowResponse, CreateConsoleLoginUrlRequest, CreateLegalSealQrCodeRequest, CreateCloseOrganizationUrlRequest, CreatePersonAuthCertificateImageResponse, ModifyPartnerAutoSignAuthUrlRequest, CreateEmployeeQualificationSealQrCodeRequest, DescribeBatchOrganizationRegistrationTasksRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, CreateRequestWithEncryptionRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, CreateCloseOrganizationUrlResponse, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ChannelCreateDynamicFlowApproverRequest, ModifyFlowDeadlineResponse, DescribeFlowDetailInfoResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, OperateTemplateResponse, CreateFlowBlockchainEvidenceUrlResponse, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateBatchAdminChangeInvitationsUrlResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelDescribeBillUsageDetailResponse, CreateEmployeeChangeUrlResponse, ChannelRenewAutoSignLicenseRequest, ChannelCreatePreparedPersonalEsignRequest, CancelOrganizationFlowsRequest, CreatePersonAuthCertificateImageRequest, PrepareFlowsRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, CreateEmployeeChangeUrlRequest, ChannelDescribeUserAutoSignStatusRequest, CreateModifyAdminAuthorizationUrlRequest, ChannelModifyRoleResponse, ModifyOrganizationBusinessInfoRequest, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreateBatchOrganizationAuthorizationUrlResponse, CreatePartnerAutoSignAuthUrlRequest, DescribeBatchOrganizationRegistrationTasksResponse, ChannelCreateBatchCancelFlowUrlRequest, ChannelDescribeAccountBillDetailResponse, CreateFlowForwardsResponse, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, CreateChannelSubOrganizationActiveResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, DeleteOrganizationAuthorizationsRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreatePrepareFlowGroupResponse, DescribeCancelFlowsTaskRequest, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelUpdateSealStatusResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateBatchInitOrganizationUrlRequest, CreateFlowGroupSignReviewRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateBatchAdminChangeInvitationsRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, CreateSealByImageRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, CreateBatchOrganizationAuthorizationUrlRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeAccountBillDetailRequest, ChannelDescribeEmployeesResponse, CreateModifyAdminAuthorizationUrlResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, SyncProxyOrganizationRequest, DescribeChannelFlowEvidenceReportResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateFlowBlockchainEvidenceUrlRequest, DescribeUserFlowTypeRequest, ChannelCreateFlowApproversRequest, ChannelDescribeBillUsageDetailRequest, ChannelCreateFlowRemindsRequest, DescribeExtendedServiceAuthInfoResponse, CreateFileConvertTaskResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -637,12 +637,126 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
637
637
  */
638
638
  CreateBatchInitOrganizationUrl(req: CreateBatchInitOrganizationUrlRequest, cb?: (error: string, rep: CreateBatchInitOrganizationUrlResponse) => void): Promise<CreateBatchInitOrganizationUrlResponse>;
639
639
  /**
640
- * 通过此接口(ChannelDescribeAccountBillDetail)查询该第三方平台子客账号绑定中、剩余可绑定账号等套餐使用情况。
641
- <ul>
642
- <li>对于渠道客户企业的查询,通过指定渠道企业的唯一标识(Agent.ProxyOrganizationId)来查询“子客账号”套餐消耗详情</li>
643
- </ul>
640
+ * 该接口支持对请求内容进行加密传输。调用方需使用约定的 AES-CBC 或 SM4-CBC 算法对请求内容进行加密,并使用 HMAC-SHA256 或 HMAC-SM3 算法对 IV 和加密后的数据进行完整性校验,防止请求内容被篡改。
641
+
642
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/391df0a37c2b213445c4909ba98824ac.svg)
643
+
644
+ **请求端加密流程**
645
+ 1. 每次请求使用密码学安全的随机源生成 16 字节 的 IV。每次请求必须重新生成,严禁复用。
646
+ 2. 使用约定的 AES-CBC 或 SM4-CBC 算法对原始请求体进行加密,使用 PKCS#7 Padding。
647
+ 3. 将加密后的密文原始字节进行标准 Base64 编码,作为 EncryptedData 参数。
648
+ 4. 将 IV 原始字节进行标准 Base64 编码,作为 IV 参数。
649
+ 5. 对 IV 原始字节和密文原始字节直接拼接(不添加分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)
650
+ 6. 将 HMAC 的结果进行 标准 Base64 编码,作为 EncryptionSignature 参数。
651
+
652
+ **响应端解密流程**
653
+ 1. 先判断本接口自身是否返回外层错误,此时错误为明文(标准腾讯云错误体),有则直接失败处理。
654
+ 2. 分别对 IV、EncryptedData、EncryptionSignature 做标准 Base64 解码,得到原始字节。
655
+ 3. 将 IV 与密文原始字节直接拼接(无分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)。
656
+ 4. 与响应中 EncryptionSignature 解码后的字节做恒定时间比较,不一致立即失败,不得继续解密。
657
+ 5. 使用约定的 AES-CBC 或 SM4-CBC,以 IV 和密钥解密 EncryptedData,去除 PKCS#7 Padding 得到明文。
658
+ 6. 先用腾讯云标准错误体反序列化明文,判断被加密业务接口是否返回 Error。
659
+ 7. 无业务错误时,再用目标业务接口的响应结构体反序列化明文,取出实际业务参数。
660
+
661
+ **响应端错误处理**
662
+ 1. 外层错误(本接口本身调用失败):返回标准腾讯云错误 JSON(含 Error.Code / Error.Message),无 EncryptedData,不需要解密即可处理。
663
+ 2. 内层错误(业务接口执行失败):外层成功,但解密后的明文里包含 Error.Code / Error.Message,按目标业务接口的错误规范处理。
664
+
665
+ **处理过程示例**
666
+ ```
667
+ # ========== 前置约定 ==========
668
+ AESKey : 加密 密钥(AES 32 字节,SM4 16 字节)
669
+ HMACKey : HMAC 密钥(与加密密钥需要不同)
670
+ ALGO : AES-CBC 或 SM4-CBC,双方约定
671
+ HMAC : ALGO == AES-CBC ? HMAC-SHA256 : HMAC-SM3
672
+
673
+ # ========== 请求端:加密并调用 ==========
674
+ function CallWithEncryption(bizAction, bizApplicationId, bizRequestObj):
675
+ # 1. 序列化业务请求
676
+ plaintext = JSON.stringify(bizRequestObj)
677
+ # 2. 生成 16 字节随机 IV(每次新生成,禁止复用)
678
+ iv = SecureRandom(16)
679
+ # 3. 对称加密(PKCS#7 Padding)
680
+ ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
681
+ # 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
682
+ signature = HMAC(HMACKey, concat(iv, ciphertext))
683
+ # 5. 组装外层请求参数(三段均为标准 Base64)
684
+ encReq = {
685
+ RequestAction: bizAction,
686
+ ApplicationId: bizApplicationId,
687
+ IV: Base64(iv),
688
+ EncryptedData: Base64(ciphertext),
689
+ EncryptionSignature: Base64(signature),
690
+ }
691
+ # 6. 调用 CreateRequestWithEncryption
692
+ # TC3-HMAC-SHA256 鉴权由官方 SDK 自动完成
693
+ encResp = CloudAPI.CreateRequestWithEncryption(encReq)
694
+ # 7. 外层错误:明文,直接抛出
695
+ if encResp.Error != nil:
696
+ raise OuterError(encResp.Error)
697
+ # 8. 解密并返回业务响应
698
+ return DecryptResponse(encResp.Response)
699
+
700
+ # ========== 响应端:校验并解密 ==========
701
+ function DecryptResponse(resp):
702
+ # 1. Base64 解码
703
+ ivBytes = Base64Decode(resp.IV)
704
+ ctBytes = Base64Decode(resp.EncryptedData)
705
+ sigBytes = Base64Decode(resp.EncryptionSignature)
706
+ # 2. 重新计算 HMAC
707
+ expected = HMAC(HMACKey, concat(ivBytes, ctBytes))
708
+ # 3. 恒定时间比较,失败立即终止(不得继续解密)
709
+ if not ConstantTimeEqual(expected, sigBytes):
710
+ raise SignatureMismatch
711
+ # 4. 对称解密,去除 PKCS#7 Padding
712
+ plaintext = SymmetricDecrypt(ALGO, AESKey, ivBytes, ctBytes)
713
+ # 5. 先按腾讯云错误体解析,判断业务是否失败
714
+ bizErr = TryParseTencentCloudError(plaintext)
715
+ if bizErr != nil:
716
+ raise BusinessError(bizErr)
717
+ # 6. 按目标业务接口的响应结构反序列化
718
+ return JSON.parse(plaintext, BizResponseSchema)
719
+ ```
720
+
721
+ **AES-CBC 示例**
722
+ 以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
723
+
724
+ 加密密钥:AES-CBC-Key-1234
725
+ 签名密钥:AES-HMAC-Key-123
726
+ IV:1234567890abcdef
727
+ 请求内容:{"Request": "This is a test."}
728
+
729
+ 最终请求参数:
730
+ ```
731
+ {
732
+ "RequestAction": "DescribeFlowComponents",
733
+ "ApplicationId: "yD******************************,
734
+ "IV": "MTIzNDU2Nzg5MGFiY2RlZg==",
735
+ "EncryptedData": "Iqp2W1jislwMNmE7bH9dKZZiMQsfkAPyvAAqDFRnWLw=",
736
+ "EncryptionSignature": "4TT3PUCZgZT7YmEPtXDm5PDcM6xT7FoYHfMW8xunB5I="
737
+ }
738
+ ```
739
+
740
+ **SM4-CBC 示例**
741
+ 以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
742
+
743
+ 加密密钥:SM4-CBC-Key-1234
744
+ 签名密钥:SM4-HMAC-Key-123
745
+ IV:fedcba0987654321
746
+ 请求内容:{"Request": "This is a test."}
747
+
748
+ 最终请求参数:
749
+ ```
750
+ {
751
+ "RequestAction": "DescribeFlowComponents",
752
+ "ApplicationId: "yD******************************,
753
+ "IV": "ZmVkY2JhMDk4NzY1NDMyMQ==",
754
+ "EncryptedData": "GwUovQhNUPaUnVM/UDXMtPOYTpTSi2B1oyZDFbyyvns=",
755
+ "EncryptionSignature": "nHB/v/AvOaDCQ66esFNnp12lHKcGkwaLGid0Warl/KE="
756
+ }
757
+ ```
644
758
  */
645
- ChannelDescribeAccountBillDetail(req: ChannelDescribeAccountBillDetailRequest, cb?: (error: string, rep: ChannelDescribeAccountBillDetailResponse) => void): Promise<ChannelDescribeAccountBillDetailResponse>;
759
+ CreateRequestWithEncryption(req: CreateRequestWithEncryptionRequest, cb?: (error: string, rep: CreateRequestWithEncryptionResponse) => void): Promise<CreateRequestWithEncryptionResponse>;
646
760
  /**
647
761
  * 您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。
648
762
 
@@ -1132,6 +1246,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1132
1246
  **这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**
1133
1247
  */
1134
1248
  DeleteOrganizationAuthorizations(req: DeleteOrganizationAuthorizationsRequest, cb?: (error: string, rep: DeleteOrganizationAuthorizationsResponse) => void): Promise<DeleteOrganizationAuthorizationsResponse>;
1249
+ /**
1250
+ * 通过此接口(ChannelDescribeAccountBillDetail)查询该第三方平台子客账号绑定中、剩余可绑定账号等套餐使用情况。
1251
+ <ul>
1252
+ <li>对于渠道客户企业的查询,通过指定渠道企业的唯一标识(Agent.ProxyOrganizationId)来查询“子客账号”套餐消耗详情</li>
1253
+ </ul>
1254
+ */
1255
+ ChannelDescribeAccountBillDetail(req: ChannelDescribeAccountBillDetailRequest, cb?: (error: string, rep: ChannelDescribeAccountBillDetailResponse) => void): Promise<ChannelDescribeAccountBillDetailResponse>;
1135
1256
  /**
1136
1257
  * 在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:
1137
1258
  1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。