tencentcloud-sdk-nodejs 4.0.759 → 4.0.760

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 (64) hide show
  1. package/CHANGELOG.md +270 -0
  2. package/SERVICE_CHANGELOG.md +481 -8
  3. package/package.json +1 -1
  4. package/products.md +22 -22
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/batch/v20170312/batch_models.ts +2 -2
  7. package/src/services/cdwdoris/v20211228/cdwdoris_client.ts +2 -2
  8. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +3 -3
  9. package/src/services/cls/v20201016/cls_models.ts +1 -1
  10. package/src/services/csip/v20221121/csip_client.ts +13 -0
  11. package/src/services/csip/v20221121/csip_models.ts +152 -0
  12. package/src/services/cynosdb/v20190107/cynosdb_models.ts +4 -4
  13. package/src/services/dlc/v20210125/dlc_models.ts +17 -1
  14. package/src/services/eb/v20210416/eb_models.ts +24 -15
  15. package/src/services/ess/v20201111/ess_client.ts +23 -6
  16. package/src/services/ess/v20201111/ess_models.ts +167 -28
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +41 -1
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +271 -73
  19. package/src/services/facefusion/v20220927/facefusion_models.ts +2 -2
  20. package/src/services/iai/v20180301/iai_models.ts +1 -1
  21. package/src/services/iai/v20200303/iai_models.ts +1 -1
  22. package/src/services/ioa/v20220601/ioa_client.ts +1 -0
  23. package/src/services/ioa/v20220601/ioa_models.ts +226 -0
  24. package/src/services/monitor/v20180724/monitor_client.ts +3 -2
  25. package/src/services/monitor/v20180724/monitor_models.ts +46 -10
  26. package/src/services/ssl/v20191205/ssl_models.ts +8 -0
  27. package/src/services/tat/v20201028/tat_models.ts +96 -101
  28. package/src/services/teo/v20220901/teo_models.ts +10 -10
  29. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  30. package/src/services/wedata/v20210820/wedata_models.ts +26 -8
  31. package/tencentcloud/common/sdk_version.d.ts +1 -1
  32. package/tencentcloud/common/sdk_version.js +1 -1
  33. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  34. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_client.d.ts +2 -2
  35. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_client.js +2 -2
  36. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +3 -3
  37. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  38. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +5 -1
  39. package/tencentcloud/services/csip/v20221121/csip_client.js +6 -0
  40. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +149 -0
  41. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +4 -4
  42. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +17 -1
  43. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +24 -15
  44. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +11 -4
  45. package/tencentcloud/services/ess/v20201111/ess_client.js +12 -3
  46. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +163 -28
  47. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +22 -1
  48. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +25 -0
  49. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +264 -73
  50. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +2 -2
  51. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +1 -1
  52. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +1 -1
  53. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +225 -0
  54. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +2 -2
  55. package/tencentcloud/services/monitor/v20180724/monitor_client.js +2 -2
  56. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +45 -10
  57. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +8 -0
  58. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +95 -100
  59. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +10 -10
  60. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  61. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +26 -8
  62. package/test/csip.v20221121.test.js +10 -0
  63. package/test/ess.v20201111.test.js +10 -0
  64. package/test/essbasic.v20210526.test.js +20 -0
@@ -34,13 +34,13 @@ class Client extends abstract_client_1.AbstractClient {
34
34
  return this.request("DescribeInstances", req, cb);
35
35
  }
36
36
  /**
37
- * 根据实例ID查询某个实例的具体信息
37
+ * 根据集群ID查询某个集群的具体信息
38
38
  */
39
39
  async DescribeInstance(req, cb) {
40
40
  return this.request("DescribeInstance", req, cb);
41
41
  }
42
42
  /**
43
- * 获取实例节点信息列表
43
+ * 获取集群节点信息列表
44
44
  */
45
45
  async DescribeInstanceNodes(req, cb) {
46
46
  return this.request("DescribeInstanceNodes", req, cb);
@@ -96,12 +96,12 @@ export interface DescribeInstanceNodesResponse {
96
96
  /**
97
97
  * 总数
98
98
  */
99
- TotalCount: number;
99
+ TotalCount?: number;
100
100
  /**
101
101
  * 实例节点总数
102
102
  注意:此字段可能返回 null,表示取不到有效值。
103
103
  */
104
- InstanceNodesList: Array<InstanceNode>;
104
+ InstanceNodesList?: Array<InstanceNode>;
105
105
  /**
106
106
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
107
107
  */
@@ -377,7 +377,7 @@ export interface DescribeInstanceResponse {
377
377
  /**
378
378
  * 实例描述信息
379
379
  */
380
- InstanceInfo: InstanceInfo;
380
+ InstanceInfo?: InstanceInfo;
381
381
  /**
382
382
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
383
383
  */
@@ -1481,7 +1481,7 @@ export interface CreateCosRechargeRequest {
1481
1481
  */
1482
1482
  LogType: string;
1483
1483
  /**
1484
- * supported: "", "gzip", "lzop", "snappy”; 默认空
1484
+ * supported: "", "gzip", "lzop", "snappy"; 默认空
1485
1485
  */
1486
1486
  Compress?: string;
1487
1487
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribeDbAssetInfoResponse, DeleteRiskScanTaskRequest, DescribeRiskCenterAssetViewWeakPasswordRiskListResponse, DescribeVULRiskAdvanceCFGListResponse, ModifyRiskCenterRiskStatusRequest, DescribeScanReportListRequest, DescribeVpcAssetsResponse, StopRiskCenterTaskRequest, DescribeVULRiskAdvanceCFGListRequest, DescribeRiskCenterAssetViewCFGRiskListRequest, DescribeDomainAssetsRequest, DeleteDomainAndIpRequest, DescribeNICAssetsRequest, DescribeScanTaskListRequest, DescribeRiskCenterWebsiteRiskListResponse, DescribeScanReportListResponse, DescribeSearchBugInfoRequest, AddNewBindRoleUserRequest, DescribeListenerListResponse, CreateRiskCenterScanTaskResponse, DescribeSubnetAssetsResponse, DescribeRiskCenterAssetViewPortRiskListRequest, StopRiskCenterTaskResponse, DescribeVpcAssetsRequest, DescribeRiskCenterAssetViewWeakPasswordRiskListRequest, DescribeCVMAssetsResponse, DescribePublicIpAssetsRequest, DescribeCVMAssetInfoRequest, CreateRiskCenterScanTaskRequest, DescribeRiskCenterAssetViewCFGRiskListResponse, DescribeRiskCenterVULViewVULRiskListResponse, DescribeRiskCenterVULViewVULRiskListRequest, DescribeScanTaskListResponse, DescribeClusterPodAssetsRequest, DescribeCVMAssetInfoResponse, DescribePublicIpAssetsResponse, DescribeTaskLogURLResponse, DescribeDbAssetInfoRequest, DescribeRiskCenterWebsiteRiskListRequest, DescribeSubnetAssetsRequest, DescribeClusterPodAssetsResponse, DescribeGatewayAssetsResponse, DescribeRiskCenterPortViewPortRiskListRequest, DescribeRiskCenterPortViewPortRiskListResponse, DeleteDomainAndIpResponse, AddNewBindRoleUserResponse, DescribeDbAssetsRequest, CreateDomainAndIpResponse, DescribeRiskCenterAssetViewVULRiskListRequest, CreateDomainAndIpRequest, DescribeSearchBugInfoResponse, DescribeTaskLogListResponse, DescribeDomainAssetsResponse, DescribeDbAssetsResponse, DescribeNICAssetsResponse, DescribeRiskCenterAssetViewVULRiskListResponse, DescribeCVMAssetsRequest, DescribeRiskCenterServerRiskListRequest, DescribeRiskCenterServerRiskListResponse, DescribeListenerListRequest, DeleteRiskScanTaskResponse, DescribeGatewayAssetsRequest, ModifyRiskCenterRiskStatusResponse, DescribeTaskLogListRequest, DescribeRiskCenterAssetViewPortRiskListResponse, DescribeTaskLogURLRequest } from "./csip_models";
3
+ import { DescribeDbAssetInfoResponse, DeleteRiskScanTaskRequest, DescribeRiskCenterAssetViewWeakPasswordRiskListResponse, DescribeVULRiskAdvanceCFGListResponse, DescribeOrganizationUserInfoRequest, ModifyRiskCenterRiskStatusRequest, DescribeScanReportListRequest, DescribeVpcAssetsResponse, StopRiskCenterTaskRequest, DescribeVULRiskAdvanceCFGListRequest, DescribeRiskCenterAssetViewCFGRiskListRequest, DescribeDomainAssetsRequest, DeleteDomainAndIpRequest, DescribeNICAssetsRequest, DescribeScanTaskListRequest, DescribeRiskCenterWebsiteRiskListResponse, DescribeScanReportListResponse, DescribeSearchBugInfoRequest, AddNewBindRoleUserRequest, DescribeOrganizationUserInfoResponse, DescribeListenerListResponse, CreateRiskCenterScanTaskResponse, DescribeSubnetAssetsResponse, DescribeRiskCenterAssetViewPortRiskListRequest, StopRiskCenterTaskResponse, DescribeVpcAssetsRequest, DescribeRiskCenterAssetViewWeakPasswordRiskListRequest, DescribeCVMAssetsResponse, DescribePublicIpAssetsRequest, DescribeCVMAssetInfoRequest, CreateRiskCenterScanTaskRequest, DescribeRiskCenterAssetViewCFGRiskListResponse, DescribeRiskCenterVULViewVULRiskListResponse, DescribeRiskCenterVULViewVULRiskListRequest, DescribeScanTaskListResponse, DescribeClusterPodAssetsRequest, DescribeCVMAssetInfoResponse, DescribePublicIpAssetsResponse, DescribeTaskLogURLResponse, DescribeDbAssetInfoRequest, DescribeRiskCenterWebsiteRiskListRequest, DescribeSubnetAssetsRequest, DescribeClusterPodAssetsResponse, DescribeGatewayAssetsResponse, DescribeRiskCenterPortViewPortRiskListRequest, DescribeRiskCenterPortViewPortRiskListResponse, DeleteDomainAndIpResponse, AddNewBindRoleUserResponse, DescribeDbAssetsRequest, CreateDomainAndIpResponse, DescribeRiskCenterAssetViewVULRiskListRequest, CreateDomainAndIpRequest, DescribeSearchBugInfoResponse, DescribeTaskLogListResponse, DescribeDomainAssetsResponse, DescribeDbAssetsResponse, DescribeNICAssetsResponse, DescribeRiskCenterAssetViewVULRiskListResponse, DescribeCVMAssetsRequest, DescribeRiskCenterServerRiskListRequest, DescribeRiskCenterServerRiskListResponse, DescribeListenerListRequest, DeleteRiskScanTaskResponse, DescribeGatewayAssetsRequest, ModifyRiskCenterRiskStatusResponse, DescribeTaskLogListRequest, DescribeRiskCenterAssetViewPortRiskListResponse, DescribeTaskLogURLRequest } from "./csip_models";
4
4
  /**
5
5
  * csip client
6
6
  * @class
@@ -127,6 +127,10 @@ export declare class Client extends AbstractClient {
127
127
  * 修改风险中心风险状态
128
128
  */
129
129
  ModifyRiskCenterRiskStatus(req: ModifyRiskCenterRiskStatusRequest, cb?: (error: string, rep: ModifyRiskCenterRiskStatusResponse) => void): Promise<ModifyRiskCenterRiskStatusResponse>;
130
+ /**
131
+ * 查询集团账号用户列表
132
+ */
133
+ DescribeOrganizationUserInfo(req: DescribeOrganizationUserInfoRequest, cb?: (error: string, rep: DescribeOrganizationUserInfoResponse) => void): Promise<DescribeOrganizationUserInfoResponse>;
130
134
  /**
131
135
  * 停止扫风险中心扫描任务
132
136
  */
@@ -207,6 +207,12 @@ class Client extends abstract_client_1.AbstractClient {
207
207
  async ModifyRiskCenterRiskStatus(req, cb) {
208
208
  return this.request("ModifyRiskCenterRiskStatus", req, cb);
209
209
  }
210
+ /**
211
+ * 查询集团账号用户列表
212
+ */
213
+ async DescribeOrganizationUserInfo(req, cb) {
214
+ return this.request("DescribeOrganizationUserInfo", req, cb);
215
+ }
210
216
  /**
211
217
  * 停止扫风险中心扫描任务
212
218
  */
@@ -104,6 +104,19 @@ export interface TaskCenterWeakPwdRiskInputParam {
104
104
  */
105
105
  Enable: number;
106
106
  }
107
+ /**
108
+ * DescribeOrganizationUserInfo请求参数结构体
109
+ */
110
+ export interface DescribeOrganizationUserInfoRequest {
111
+ /**
112
+ * 过滤内容
113
+ */
114
+ Filter?: Filter;
115
+ /**
116
+ * 不支持多云
117
+ */
118
+ NotSupportCloud?: boolean;
119
+ }
107
120
  /**
108
121
  * ModifyRiskCenterRiskStatus请求参数结构体
109
122
  */
@@ -845,6 +858,123 @@ export interface DataSearchBug {
845
858
  */
846
859
  CWPFix?: number;
847
860
  }
861
+ /**
862
+ * 集团账号成员详情
863
+ */
864
+ export interface OrganizationUserInfo {
865
+ /**
866
+ * 成员账号Uin
867
+ 注意:此字段可能返回 null,表示取不到有效值。
868
+ */
869
+ Uin?: string;
870
+ /**
871
+ * 成员账号名称
872
+ 注意:此字段可能返回 null,表示取不到有效值。
873
+ */
874
+ NickName?: string;
875
+ /**
876
+ * 部门节点名称,账号所属部门
877
+ 注意:此字段可能返回 null,表示取不到有效值。
878
+ */
879
+ NodeName?: string;
880
+ /**
881
+ * 资产数量
882
+ 注意:此字段可能返回 null,表示取不到有效值。
883
+ */
884
+ AssetCount?: number;
885
+ /**
886
+ * 风险数量
887
+ 注意:此字段可能返回 null,表示取不到有效值。
888
+ */
889
+ RiskCount?: number;
890
+ /**
891
+ * 攻击数量
892
+ 注意:此字段可能返回 null,表示取不到有效值。
893
+ */
894
+ AttackCount?: number;
895
+ /**
896
+ * Member/Admin/;成员或者管理员
897
+ 注意:此字段可能返回 null,表示取不到有效值。
898
+ */
899
+ Role?: string;
900
+ /**
901
+ * 成员账号id
902
+ 注意:此字段可能返回 null,表示取不到有效值。
903
+ */
904
+ MemberId?: string;
905
+ /**
906
+ * 成员账号Appid
907
+ 注意:此字段可能返回 null,表示取不到有效值。
908
+ */
909
+ AppId?: string;
910
+ /**
911
+ * 账号加入方式,create/invite
912
+ 注意:此字段可能返回 null,表示取不到有效值。
913
+ */
914
+ JoinType?: string;
915
+ /**
916
+ * 空则未开启,否则不同字符串对应不同版本,common为通用,不区分版本
917
+ 注意:此字段可能返回 null,表示取不到有效值。
918
+ */
919
+ CFWProtect?: string;
920
+ /**
921
+ * 空则未开启,否则不同字符串对应不同版本,common为通用,不区分版本
922
+ 注意:此字段可能返回 null,表示取不到有效值。
923
+ */
924
+ WAFProtect?: string;
925
+ /**
926
+ * 空则未开启,否则不同字符串对应不同版本,common为通用,不区分版本
927
+ 注意:此字段可能返回 null,表示取不到有效值。
928
+ */
929
+ CWPProtect?: string;
930
+ /**
931
+ * 1启用,0未启用
932
+ 注意:此字段可能返回 null,表示取不到有效值。
933
+ */
934
+ Enable?: number;
935
+ /**
936
+ * "Free" //免费版 "Advanced" //高级版 "Enterprise" //企业版 "Ultimate" //旗舰版
937
+ 注意:此字段可能返回 null,表示取不到有效值。
938
+ */
939
+ CSIPProtect?: string;
940
+ /**
941
+ * 1为配额消耗者
942
+ 注意:此字段可能返回 null,表示取不到有效值。
943
+ */
944
+ QuotaConsumer?: number;
945
+ /**
946
+ * 账户类型,0为腾讯云账户,1为AWS账户
947
+ 注意:此字段可能返回 null,表示取不到有效值。
948
+ */
949
+ CloudType?: number;
950
+ /**
951
+ * 0为缺省值,1为10分钟,2为1小时,3为24小时
952
+ 注意:此字段可能返回 null,表示取不到有效值。
953
+ */
954
+ SyncFrequency?: number;
955
+ /**
956
+ * 多云账户是否过期
957
+ 注意:此字段可能返回 null,表示取不到有效值。
958
+ */
959
+ IsExpired?: boolean;
960
+ /**
961
+ * 多云账户 权限列表
962
+ 注意:此字段可能返回 null,表示取不到有效值。
963
+ */
964
+ PermissionList?: Array<string>;
965
+ /**
966
+ * 1
967
+ 注意:此字段可能返回 null,表示取不到有效值。
968
+ */
969
+ AuthType?: number;
970
+ /**
971
+ * 0 腾讯云集团账户
972
+ 1 腾讯云接入账户
973
+ 2 非腾讯云
974
+ 注意:此字段可能返回 null,表示取不到有效值。
975
+ */
976
+ TcMemberType?: number;
977
+ }
848
978
  /**
849
979
  * 安全中心资产标签
850
980
  */
@@ -1194,6 +1324,25 @@ export interface TaskLogURL {
1194
1324
  * AddNewBindRoleUser请求参数结构体
1195
1325
  */
1196
1326
  export declare type AddNewBindRoleUserRequest = null;
1327
+ /**
1328
+ * DescribeOrganizationUserInfo返回参数结构体
1329
+ */
1330
+ export interface DescribeOrganizationUserInfoResponse {
1331
+ /**
1332
+ * 总条数
1333
+ 注意:此字段可能返回 null,表示取不到有效值。
1334
+ */
1335
+ TotalCount?: number;
1336
+ /**
1337
+ * 集团用户列表
1338
+ 注意:此字段可能返回 null,表示取不到有效值。
1339
+ */
1340
+ Data?: Array<OrganizationUserInfo>;
1341
+ /**
1342
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1343
+ */
1344
+ RequestId?: string;
1345
+ }
1197
1346
  /**
1198
1347
  * 网卡资产
1199
1348
  */
@@ -3791,24 +3791,24 @@ export interface CreateClustersRequest {
3791
3791
  */
3792
3792
  DbMode?: string;
3793
3793
  /**
3794
- * 当DbMode为SEVERLESS时必填
3794
+ * 当DbMode为SERVERLESS时必填
3795
3795
  cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回
3796
3796
  */
3797
3797
  MinCpu?: number;
3798
3798
  /**
3799
- * 当DbMode为SEVERLESS时必填:
3799
+ * 当DbMode为SERVERLESS时必填:
3800
3800
  cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回
3801
3801
  */
3802
3802
  MaxCpu?: number;
3803
3803
  /**
3804
- * 当DbMode为SEVERLESS时,指定集群是否自动暂停,可选范围
3804
+ * 当DbMode为SERVERLESS时,指定集群是否自动暂停,可选范围
3805
3805
  <li>yes</li>
3806
3806
  <li>no</li>
3807
3807
  默认值:yes
3808
3808
  */
3809
3809
  AutoPause?: string;
3810
3810
  /**
3811
- * 当DbMode为SEVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200]
3811
+ * 当DbMode为SERVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200]
3812
3812
  默认值:600
3813
3813
  */
3814
3814
  AutoPauseDelay?: number;
@@ -832,6 +832,10 @@ export interface DescribeSparkSessionBatchSQLRequest {
832
832
  * SparkSQL唯一标识
833
833
  */
834
834
  BatchId: string;
835
+ /**
836
+ * 用户自定义主键, 若不为空,则按照该值查询
837
+ */
838
+ CustomKey?: string;
835
839
  }
836
840
  /**
837
841
  * SmartOptimizerPolicy
@@ -1323,7 +1327,7 @@ export interface UpdateUserDataEngineConfigRequest {
1323
1327
  */
1324
1328
  DataEngineId: string;
1325
1329
  /**
1326
- * 引擎配置项
1330
+ * 用户自定义引擎配置项集合。该参数需要传用户需要添加的全部配置项,例如,已有配置项k1:v1,添加k2:v2,需要传[k1:v1,k2:v2]。
1327
1331
  */
1328
1332
  DataEngineConfigPairs?: Array<DataEngineConfigPair>;
1329
1333
  /**
@@ -1771,6 +1775,10 @@ export interface CancelSparkSessionBatchSQLRequest {
1771
1775
  * 批任务唯一标识
1772
1776
  */
1773
1777
  BatchId: string;
1778
+ /**
1779
+ * 用户自定义主键,若不为空,则使用该值进行查询
1780
+ */
1781
+ CustomKey?: string;
1774
1782
  }
1775
1783
  /**
1776
1784
  * 任务概览
@@ -4680,6 +4688,10 @@ export interface DescribeSparkSessionBatchSqlLogRequest {
4680
4688
  * SparkSQL唯一标识
4681
4689
  */
4682
4690
  BatchId: string;
4691
+ /**
4692
+ * 用户自定义主键,若不为空,则按照该值进行查询
4693
+ */
4694
+ CustomKey?: string;
4683
4695
  }
4684
4696
  /**
4685
4697
  * 同一个用户绑定的工作组集合
@@ -5842,6 +5854,10 @@ export interface CreateSparkSessionBatchSQLRequest {
5842
5854
  * 是否继承集群的资源类配置:0:不继承(默认),1:继承集群;
5843
5855
  */
5844
5856
  IsInherit?: number;
5857
+ /**
5858
+ * 用户自定义主键,需唯一
5859
+ */
5860
+ CustomKey?: string;
5845
5861
  }
5846
5862
  /**
5847
5863
  * ListTaskJobLogDetail返回参数结构体
@@ -51,7 +51,7 @@ export interface CheckRuleRequest {
51
51
  */
52
52
  export interface LogFilters {
53
53
  /**
54
- * 过滤字段名称
54
+ * 过滤字段名称,取值范围如下:region(地域),type(事件类型),source(事件源),status(事件状态)
55
55
  */
56
56
  Key: string;
57
57
  /**
@@ -126,7 +126,7 @@ export interface CreateTransformationRequest {
126
126
  */
127
127
  RuleId: string;
128
128
  /**
129
- * 一个转换规则列表,当前仅限定一个
129
+ * 一个转换规则列表,当前仅限定一个;示例如下:[{"Extraction":{"ExtractionInputPath":"$.data.payload","Format":"JSON"},"EtlFilter":{"Filter":"{\"source\":\"ckafka.cloud.tencent\"}"},"Transform":{"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"},{"Key":"table","Value":"$.source.table","ValueType":"JSONPATH"},{"Key":"id","Value":"$.after.id","ValueType":"JSONPATH"},{"Key":"app_id","Value":"$.after.app_id","ValueType":"JSONPATH"},{"Key":"spu_id","Value":"$.after.spu_id","ValueType":"JSONPATH"}]}}]
130
130
  */
131
131
  Transformations: Array<Transformation>;
132
132
  }
@@ -185,11 +185,20 @@ export interface CreateTargetRequest {
185
185
  */
186
186
  EventBusId: string;
187
187
  /**
188
- * 目标类型
188
+ * 目标类型;取值范围:scf(云函数)/cls(日志服务)/amp(消息推送)/ckafka(消息推送)/es(大数据elastic-search)
189
189
  */
190
190
  Type: string;
191
191
  /**
192
- * 目标描述
192
+ * 目标描述;scf类型示例:
193
+ {"ResourceDescription":"qcs::scf:ap-guangzhou:uin/2252646423:namespace/default/function/john-test-0326/$LATEST"};
194
+ cls类型示例:
195
+ {"ResourceDescription":"qcs::cls:ap-guangzhou:uin/12323442323:topic/7103f705-6c38-4b64-ac9d-428af0f2e732"}
196
+ ckafka类型示例:
197
+ {"ResourceDescription":"qcs::ckafka:ap-guangzhou:uin/1500000688:ckafkaId/uin/1500000688/ckafka-018q1nwj","CkafkaTargetParams":{"TopicName":"alert","RetryPolicy":{"RetryInterval":60,"MaxRetryAttempts":360}}}
198
+ amp类型-邮件/短信示例:
199
+ {"ResourceDescription":"qcs::eb-amp:ap-guangzhou:uin/100012505002:","AMPParams":{"NotificationTemplateId":10181,"Lang":"cn","NoticeReceivers":[{"UserType":"User","UserIds":["9424525"],"TimeWindow":{"From":"09:30:00","To":"23:30:00"},"Channels":["Email","SMS"]}]}}
200
+ es类型示例:
201
+ {"ResourceDescription":"qcs::es:ap-guangzhou:uin/1500000688:instance/es-7cplmhsd","ESTargetParams":{"EsVersion":"7.14.2","UserName":"elastic","Password":"xxxxx","NetMode":"privateLink","IndexPrefix":"auto-test","IndexSuffixMode":"default","RotationInterval":"none","IndexTemplateType":"","OutputMode":"default"}}
193
202
  */
194
203
  TargetDescription: TargetDescription;
195
204
  /**
@@ -445,7 +454,7 @@ export interface CreateTargetResponse {
445
454
  /**
446
455
  * 目标ID
447
456
  */
448
- TargetId: string;
457
+ TargetId?: string;
449
458
  /**
450
459
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
451
460
  */
@@ -527,17 +536,17 @@ export interface ListTargetsRequest {
527
536
  */
528
537
  export interface Transformation {
529
538
  /**
530
- * 描述如何提取数据
539
+ * 描述如何提取数据,{"ExtractionInputPath":"$.data.payload","Format":"JSON"}
531
540
  注意:此字段可能返回 null,表示取不到有效值。
532
541
  */
533
542
  Extraction?: Extraction;
534
543
  /**
535
- * 描述如何过滤数据
544
+ * 描述如何过滤数据;{"Filter":"{\"source\":\"ckafka.cloud.tencent\"}"}
536
545
  注意:此字段可能返回 null,表示取不到有效值。
537
546
  */
538
547
  EtlFilter?: EtlFilter;
539
548
  /**
540
- * 描述如何数据转换
549
+ * 描述如何数据转换;"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"}]
541
550
  注意:此字段可能返回 null,表示取不到有效值。
542
551
  */
543
552
  Transform?: Transform;
@@ -685,7 +694,7 @@ export interface ListEventBusesRequest {
685
694
  */
686
695
  Order?: string;
687
696
  /**
688
- * 过滤条件,详见下表:实例过滤条件表。每次请求的Filters的上限为10,Filter.Values的上限为5。
697
+ * 过滤字段范围: EventBusName(事件集名称)/EventBusId(事件集Id)/Type(事件集类型:Cloud(云服务);Platform(平台型);Custom(自定义))/TagKey(标签键)。每次请求的Filters的上限为10,Filter.Values的上限为5。[{"Name":"Type","Values":["Cloud","Platform"]}]
689
698
  */
690
699
  Filters?: Array<Filter>;
691
700
  /**
@@ -700,7 +709,7 @@ export interface CreateTransformationResponse {
700
709
  /**
701
710
  * 生成的转换器id
702
711
  */
703
- TransformationId: string;
712
+ TransformationId?: string;
704
713
  /**
705
714
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
706
715
  */
@@ -1073,7 +1082,7 @@ export interface Filter {
1073
1082
  */
1074
1083
  Values: Array<string>;
1075
1084
  /**
1076
- * 过滤键的名称。
1085
+ * 过滤键的名称。EventBusName(事件集名称)/EventBusId(事件集Id)/Type(事件集类型:Cloud(云服务);Platform(平台型);Custom(自定义))/TagKey(标签键)
1077
1086
  */
1078
1087
  Name: string;
1079
1088
  }
@@ -1333,7 +1342,7 @@ export interface DescribeLogTagValueRequest {
1333
1342
  */
1334
1343
  EventBusId: string;
1335
1344
  /**
1336
- * 聚合字段
1345
+ * 聚合字段,取值范围如下:Source(事件源),RuleIds(命中规则),Subject(实例ID),Region(地域)
1337
1346
  */
1338
1347
  GroupField: string;
1339
1348
  /**
@@ -1591,11 +1600,11 @@ export interface SearchLogRequest {
1591
1600
  */
1592
1601
  Limit: number;
1593
1602
  /**
1594
- * 筛选条件
1603
+ * 事件查询筛选条件;示例如下:[{"key":"host","operator":"eq","value":"106.53.106.243"},{"type":"AND","filters":[{"key":"region","operator":"like","value":"*guangzhou*"},{"key":"type","operator":"eq","value":"cvm:ErrorEvent:GuestReboot"}]},{"type":"OR","filters":[{"key":"field1","operator":"like","value":"*access*"},{"key":"field2","operator":"eq","value":"custorm"}]}]
1595
1604
  */
1596
1605
  Filter?: Array<LogFilter>;
1597
1606
  /**
1598
- * 排序数组
1607
+ * 事件查询结果排序,["timestamp","subject"]
1599
1608
  */
1600
1609
  OrderFields?: Array<string>;
1601
1610
  /**
@@ -1704,7 +1713,7 @@ export interface PutEventsRequest {
1704
1713
  */
1705
1714
  export interface TargetDescription {
1706
1715
  /**
1707
- * QCS资源六段式,更多参考 [资源六段式](https://cloud.tencent.com/document/product/598/10606)
1716
+ * QCS资源六段式,更多参考 [资源六段式](https://cloud.tencent.com/document/product/598/10606);scf资源六段式示例[qcs::scf:ap-guangzhou:uin/123:namespace/test(函数命名空间)/function/test(函数名)/$LATEST(函数版本)] amp资源六段式示例[qcs::eb-amp:ap-guangzhou:uin/123:] ckafka资源六段式示例[qcs::ckafka:ap-guangzhou:uin/123:ckafkaId/uin/123/ckafka-123(ckafka实例Id)] cls资源六段式示例[qcs::cls:ap-guangzhou:uin/123:topic/122332442(topicId)] es资源六段式示例[qcs::es:ap-guangzhou:appid/123/uin/456:instance/es-7cplmhsd(es实例Id)]
1708
1717
  */
1709
1718
  ResourceDescription: string;
1710
1719
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeFlowBriefsResponse, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, VerifyPdfResponse, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, VerifyPdfResponse, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -179,9 +179,7 @@ export declare class Client extends AbstractClient {
179
179
  CreatePrepareFlow(req: CreatePrepareFlowRequest, cb?: (error: string, rep: CreatePrepareFlowResponse) => void): Promise<CreatePrepareFlowResponse>;
180
180
  /**
181
181
  * 创建签署流程电子文档<br />
182
- 适用场景:见创建签署流程接口。<br />
183
- 点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
184
- <a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
182
+
185
183
  注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
186
184
 
187
185
  <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
@@ -343,6 +341,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
343
341
  1. `大文件转换所需的时间可能会比较长`
344
342
  */
345
343
  GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
344
+ /**
345
+ * 查询企业扩展服务的授权详情(列表),当前支持查询以下内容:
346
+ 1. 企业自动签(本企业授权、集团企业授权、合作企业授权)
347
+ 2. 批量签署能力
348
+
349
+
350
+ 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
351
+ */
352
+ DescribeExtendedServiceAuthDetail(req: DescribeExtendedServiceAuthDetailRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthDetailResponse) => void): Promise<DescribeExtendedServiceAuthDetailResponse>;
346
353
  /**
347
354
  * 创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
348
355
  该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。
@@ -245,9 +245,7 @@ class Client extends abstract_client_1.AbstractClient {
245
245
  }
246
246
  /**
247
247
  * 创建签署流程电子文档<br />
248
- 适用场景:见创建签署流程接口。<br />
249
- 点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
250
- <a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
248
+
251
249
  注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
252
250
 
253
251
  <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
@@ -441,6 +439,17 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
441
439
  async GetTaskResultApi(req, cb) {
442
440
  return this.request("GetTaskResultApi", req, cb);
443
441
  }
442
+ /**
443
+ * 查询企业扩展服务的授权详情(列表),当前支持查询以下内容:
444
+ 1. 企业自动签(本企业授权、集团企业授权、合作企业授权)
445
+ 2. 批量签署能力
446
+
447
+
448
+ 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
449
+ */
450
+ async DescribeExtendedServiceAuthDetail(req, cb) {
451
+ return this.request("DescribeExtendedServiceAuthDetail", req, cb);
452
+ }
444
453
  /**
445
454
  * 创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
446
455
  该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。