tccli 3.0.859.1__py2.py3-none-any.whl → 3.0.861.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
@@ -48,6 +48,14 @@
48
48
  "title": "创建文件系统快照"
49
49
  }
50
50
  ],
51
+ "CreateMigrationTask": [
52
+ {
53
+ "document": "用于创建数据迁移任务,需开启白名单后才能使用。",
54
+ "input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateMigrationTask\n<公共请求参数>\n\n{\n \"BucketRegion\": \"ap-nanjing\",\n \"SrcService\": \"COS\",\n \"CoverType\": \"1\",\n \"SrcSecretKey\": \"*****************************\",\n \"BucketPath\": \"cos/\",\n \"MigrationMode\": \"0\",\n \"FileSystemId\": \"cfs-8dd58fd7\",\n \"BucketName\": \"test-1-1256238147\",\n \"FsPath\": \"/test/\",\n \"MigrationType\": \"0\",\n \"TaskName\": \"test\",\n \"SrcSecretId\": \"**************************************************\",\n \"FsName\": \"test\"\n}",
55
+ "output": "{\n \"Response\": {\n \"TaskId\": \"cfsmigrate-dfe9b1f2\",\n \"RequestId\": \"91cd4a08-a105-4c59-b229-82f0fs7363b8\"\n }\n}",
56
+ "title": "创建迁移任务"
57
+ }
58
+ ],
51
59
  "DeleteAutoSnapshotPolicy": [
52
60
  {
53
61
  "document": "",
@@ -88,6 +96,14 @@
88
96
  "title": "删除快照"
89
97
  }
90
98
  ],
99
+ "DeleteMigrationTask": [
100
+ {
101
+ "document": "用于删除数据迁移任务",
102
+ "input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteMigrationTask\n<公共请求参数>\n\n{\n \"TaskId\": \"cfsmigrate-4e78dae8\"\n}",
103
+ "output": "{\n \"Response\": {\n \"RequestId\": \"b72e3de2-6770-4388-af42-7e511935ad8e\"\n }\n}",
104
+ "title": "删除迁移"
105
+ }
106
+ ],
91
107
  "DeleteMountTarget": [
92
108
  {
93
109
  "document": "",
@@ -120,6 +136,14 @@
120
136
  "title": "查询区域可用情况"
121
137
  }
122
138
  ],
139
+ "DescribeBucketList": [
140
+ {
141
+ "document": "用于获取对象存储桶列表",
142
+ "input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBucketList\n<公共请求参数>\n\n{\n \"SrcSecretId\": \"******************************\",\n \"SrcSecretKey\": \"*****************************\",\n \"SrcService\": \"COS\"\n}",
143
+ "output": "{\n \"Response\": {\n \"BucketList\": [\n {\n \"Name\": \"1-1256238147\",\n \"Region\": \"ap-nanjing\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"ea7fe4ad-d508-41f9-bcc7-6e043102b5ba\"\n }\n}",
144
+ "title": "获取存储桶列表"
145
+ }
146
+ ],
123
147
  "DescribeCfsFileSystemClients": [
124
148
  {
125
149
  "document": "",
@@ -176,6 +200,14 @@
176
200
  "title": "查询快照"
177
201
  }
178
202
  ],
203
+ "DescribeMigrationTasks": [
204
+ {
205
+ "document": "用于获取迁移任务列表",
206
+ "input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigrationTasks\n<公共请求参数>\n\n{\n \"Limit\": 20,\n \"Offset\": 0\n}",
207
+ "output": "{\n \"Response\": {\n \"MigrationTasks\": [\n {\n \"TaskName\": \"taskName\",\n \"TaskId\": \"cfsmigrate-29d43e98\",\n \"MigrationType\": 0,\n \"MigrationMode\": 0,\n \"BucketName\": \"bucket-1\",\n \"BucketRegion\": \"oss-cn-beijing\",\n \"BucketAddress\": \"https://test-1.oss-cn-beijing.aliyuncs.com\",\n \"BucketPath\": \"\",\n \"ListAddress\": \"\",\n \"FsName\": \"t1\",\n \"FileSystemId\": \"cfs-qz5c44o1\",\n \"FsPath\": \"/ahh\",\n \"CoverType\": 0,\n \"Status\": 6,\n \"FileTotalCount\": 0,\n \"FileMigratedCount\": 0,\n \"FileFailedCount\": 0,\n \"FileTotalSize\": 0,\n \"FileMigratedSize\": 0,\n \"FileFailedSize\": 0,\n \"FileTotalList\": null,\n \"FileCompletedList\": null,\n \"FileFailedList\": null,\n \"CreateTime\": 1662023240000,\n \"EndTime\": 1662023548000\n }\n ],\n \"TotalCount\": 2,\n \"RequestId\": \"c0f7c5d9-c8c4-401a-a6da-2106f3c6db76\"\n }\n}",
208
+ "title": "获取迁移任务列表"
209
+ }
210
+ ],
179
211
  "DescribeMountTargets": [
180
212
  {
181
213
  "document": "",
@@ -216,6 +248,14 @@
216
248
  "title": "开通CFS服务"
217
249
  }
218
250
  ],
251
+ "StopMigrationTask": [
252
+ {
253
+ "document": "用于终止迁移任务",
254
+ "input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopMigrationTask\n<公共请求参数>\n\n{\n \"TaskId\": \"cfsmigrate-29de0e87\"\n}",
255
+ "output": "{\n \"Response\": {\n \"TaskId\": \"cfsmigrate-29de0e87\",\n \"Status\": 2,\n \"RequestId\": \"eff7c5d9-c8c4-401a-deda-2108d3cc8b76\"\n }\n}",
256
+ "title": "终止迁移任务"
257
+ }
258
+ ],
219
259
  "UnbindAutoSnapshotPolicy": [
220
260
  {
221
261
  "document": "",
@@ -1212,11 +1212,11 @@
1212
1212
  "status": "online"
1213
1213
  },
1214
1214
  "DescribeSearchExportList": {
1215
- "document": "导出ES查询文档列表",
1215
+ "document": "旧版日志下载接口下线\n\n导出ES查询文档列表",
1216
1216
  "input": "DescribeSearchExportListRequest",
1217
1217
  "name": "导出ES查询文档列表",
1218
1218
  "output": "DescribeSearchExportListResponse",
1219
- "status": "online"
1219
+ "status": "deprecated"
1220
1220
  },
1221
1221
  "DescribeSearchLogs": {
1222
1222
  "document": "获取历史搜索记录",
@@ -537,6 +537,58 @@ def doVerifyPdf(args, parsed_globals):
537
537
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
538
538
 
539
539
 
540
+ def doUnbindEmployeeUserIdWithClientOpenId(args, parsed_globals):
541
+ g_param = parse_global_arg(parsed_globals)
542
+
543
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
544
+ cred = credential.CVMRoleCredential()
545
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
546
+ cred = credential.STSAssumeRoleCredential(
547
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
548
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
549
+ )
550
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
551
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
552
+ else:
553
+ cred = credential.Credential(
554
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
555
+ )
556
+ http_profile = HttpProfile(
557
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
558
+ reqMethod="POST",
559
+ endpoint=g_param[OptionsDefine.Endpoint],
560
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
561
+ )
562
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
563
+ if g_param[OptionsDefine.Language]:
564
+ profile.language = g_param[OptionsDefine.Language]
565
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
566
+ client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
567
+ client._sdkVersion += ("_CLI_" + __version__)
568
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
569
+ model = models.UnbindEmployeeUserIdWithClientOpenIdRequest()
570
+ model.from_json_string(json.dumps(args))
571
+ start_time = time.time()
572
+ while True:
573
+ rsp = client.UnbindEmployeeUserIdWithClientOpenId(model)
574
+ result = rsp.to_json_string()
575
+ try:
576
+ json_obj = json.loads(result)
577
+ except TypeError as e:
578
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
579
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
580
+ break
581
+ cur_time = time.time()
582
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
583
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
584
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
585
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
586
+ else:
587
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
588
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
589
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
590
+
591
+
540
592
  def doCreateBatchCancelFlowUrl(args, parsed_globals):
541
593
  g_param = parse_global_arg(parsed_globals)
542
594
 
@@ -589,6 +641,58 @@ def doCreateBatchCancelFlowUrl(args, parsed_globals):
589
641
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
590
642
 
591
643
 
644
+ def doBindEmployeeUserIdWithClientOpenId(args, parsed_globals):
645
+ g_param = parse_global_arg(parsed_globals)
646
+
647
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
648
+ cred = credential.CVMRoleCredential()
649
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
650
+ cred = credential.STSAssumeRoleCredential(
651
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
652
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')]
653
+ )
654
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
655
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
656
+ else:
657
+ cred = credential.Credential(
658
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
659
+ )
660
+ http_profile = HttpProfile(
661
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
662
+ reqMethod="POST",
663
+ endpoint=g_param[OptionsDefine.Endpoint],
664
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
665
+ )
666
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
667
+ if g_param[OptionsDefine.Language]:
668
+ profile.language = g_param[OptionsDefine.Language]
669
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
670
+ client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
671
+ client._sdkVersion += ("_CLI_" + __version__)
672
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
673
+ model = models.BindEmployeeUserIdWithClientOpenIdRequest()
674
+ model.from_json_string(json.dumps(args))
675
+ start_time = time.time()
676
+ while True:
677
+ rsp = client.BindEmployeeUserIdWithClientOpenId(model)
678
+ result = rsp.to_json_string()
679
+ try:
680
+ json_obj = json.loads(result)
681
+ except TypeError as e:
682
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
683
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
684
+ break
685
+ cur_time = time.time()
686
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
687
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
688
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
689
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
690
+ else:
691
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
692
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
693
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
694
+
695
+
592
696
  def doCreatePreparedPersonalEsign(args, parsed_globals):
593
697
  g_param = parse_global_arg(parsed_globals)
594
698
 
@@ -2274,7 +2378,9 @@ ACTION_MAP = {
2274
2378
  "CreateUserAutoSignEnableUrl": doCreateUserAutoSignEnableUrl,
2275
2379
  "CreateFlowEvidenceReport": doCreateFlowEvidenceReport,
2276
2380
  "VerifyPdf": doVerifyPdf,
2381
+ "UnbindEmployeeUserIdWithClientOpenId": doUnbindEmployeeUserIdWithClientOpenId,
2277
2382
  "CreateBatchCancelFlowUrl": doCreateBatchCancelFlowUrl,
2383
+ "BindEmployeeUserIdWithClientOpenId": doBindEmployeeUserIdWithClientOpenId,
2278
2384
  "CreatePreparedPersonalEsign": doCreatePreparedPersonalEsign,
2279
2385
  "CreateFlowApprovers": doCreateFlowApprovers,
2280
2386
  "DeleteIntegrationRoleUsers": doDeleteIntegrationRoleUsers,
@@ -1,5 +1,12 @@
1
1
  {
2
2
  "actions": {
3
+ "BindEmployeeUserIdWithClientOpenId": {
4
+ "document": "将电子签系统员工userId与客户系统员工openId进行绑定",
5
+ "input": "BindEmployeeUserIdWithClientOpenIdRequest",
6
+ "name": "员工userid与客户系统openid绑定",
7
+ "output": "BindEmployeeUserIdWithClientOpenIdResponse",
8
+ "status": "online"
9
+ },
3
10
  "CancelFlow": {
4
11
  "document": "用于撤销签署流程\n适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。\n注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。",
5
12
  "input": "CancelFlowRequest",
@@ -280,6 +287,13 @@
280
287
  "output": "StartFlowResponse",
281
288
  "status": "online"
282
289
  },
290
+ "UnbindEmployeeUserIdWithClientOpenId": {
291
+ "document": "将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑",
292
+ "input": "UnbindEmployeeUserIdWithClientOpenIdRequest",
293
+ "name": "员工userid与客户系统openid解绑",
294
+ "output": "UnbindEmployeeUserIdWithClientOpenIdResponse",
295
+ "status": "online"
296
+ },
283
297
  "UpdateIntegrationEmployees": {
284
298
  "document": "更新员工信息(姓名,手机号,邮件),用户实名后无法更改姓名与手机号",
285
299
  "input": "UpdateIntegrationEmployeesRequest",
@@ -682,6 +696,60 @@
682
696
  ],
683
697
  "usage": "in"
684
698
  },
699
+ "BindEmployeeUserIdWithClientOpenIdRequest": {
700
+ "document": "BindEmployeeUserIdWithClientOpenId请求参数结构体",
701
+ "members": [
702
+ {
703
+ "default": "",
704
+ "document": "OpenId与UserId二选一必填一个,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且渠道channel必填,channel值为INTEGRATE,否则传入userId",
705
+ "example": "无",
706
+ "member": "UserInfo",
707
+ "name": "Operator",
708
+ "required": true,
709
+ "type": "object"
710
+ },
711
+ {
712
+ "default": "",
713
+ "document": "电子签系统员工UserId",
714
+ "example": "无",
715
+ "member": "string",
716
+ "name": "UserId",
717
+ "required": true,
718
+ "type": "string"
719
+ },
720
+ {
721
+ "default": "",
722
+ "document": "客户系统OpenId",
723
+ "example": "无",
724
+ "member": "string",
725
+ "name": "OpenId",
726
+ "required": true,
727
+ "type": "string"
728
+ }
729
+ ],
730
+ "type": "object"
731
+ },
732
+ "BindEmployeeUserIdWithClientOpenIdResponse": {
733
+ "document": "BindEmployeeUserIdWithClientOpenId返回参数结构体",
734
+ "members": [
735
+ {
736
+ "document": "绑定是否成功,1表示成功,0表示失败",
737
+ "example": "无",
738
+ "member": "int64",
739
+ "name": "Status",
740
+ "required": true,
741
+ "type": "int",
742
+ "value_allowed_null": false
743
+ },
744
+ {
745
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
746
+ "member": "string",
747
+ "name": "RequestId",
748
+ "type": "string"
749
+ }
750
+ ],
751
+ "type": "object"
752
+ },
685
753
  "CallbackInfo": {
686
754
  "document": "应用回调信息",
687
755
  "members": [
@@ -1678,7 +1746,7 @@
1678
1746
  "document": "CreateFlowReminds返回参数结构体",
1679
1747
  "members": [
1680
1748
  {
1681
- "document": "签署连接过期时间字符串:年月日-时分秒",
1749
+ "document": "催办合同详情列表",
1682
1750
  "example": "无",
1683
1751
  "member": "RemindFlowRecords",
1684
1752
  "name": "RemindFlowRecords",
@@ -4619,7 +4687,7 @@
4619
4687
  "value_allowed_null": true
4620
4688
  },
4621
4689
  {
4622
- "document": "合同(流程)的状态\n1:未签署\n2:部分签署\n3:已退回\n4:完成签署\n5:已过期\n6:已取消",
4690
+ "document": "流程状态\n- 0 还没有发起\n- 1 未签署\n- 2 部分签署\n- 3 已退回\n- 4 完成签署\n- 5 已过期\n- 6 已取消\n- 7 还没有预发起\n- 8 等待填写\n- 9 部分填写\n- 10 拒填",
4623
4691
  "example": "无",
4624
4692
  "member": "int64",
4625
4693
  "name": "FlowStatus",
@@ -6177,6 +6245,60 @@
6177
6245
  ],
6178
6246
  "usage": "both"
6179
6247
  },
6248
+ "UnbindEmployeeUserIdWithClientOpenIdRequest": {
6249
+ "document": "UnbindEmployeeUserIdWithClientOpenId请求参数结构体",
6250
+ "members": [
6251
+ {
6252
+ "default": "",
6253
+ "document": "OpenId与UserId二选一必填一个,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且渠道channel必填,channel值为INTEGRATE,否则传入userId",
6254
+ "example": "无",
6255
+ "member": "UserInfo",
6256
+ "name": "Operator",
6257
+ "required": true,
6258
+ "type": "object"
6259
+ },
6260
+ {
6261
+ "default": "",
6262
+ "document": "电子签系统员工UserId",
6263
+ "example": "无",
6264
+ "member": "string",
6265
+ "name": "UserId",
6266
+ "required": true,
6267
+ "type": "string"
6268
+ },
6269
+ {
6270
+ "default": "",
6271
+ "document": "客户系统OpenId",
6272
+ "example": "无",
6273
+ "member": "string",
6274
+ "name": "OpenId",
6275
+ "required": true,
6276
+ "type": "string"
6277
+ }
6278
+ ],
6279
+ "type": "object"
6280
+ },
6281
+ "UnbindEmployeeUserIdWithClientOpenIdResponse": {
6282
+ "document": "UnbindEmployeeUserIdWithClientOpenId返回参数结构体",
6283
+ "members": [
6284
+ {
6285
+ "document": "解绑是否成功,1表示成功,0表示失败",
6286
+ "example": "无",
6287
+ "member": "int64",
6288
+ "name": "Status",
6289
+ "required": true,
6290
+ "type": "int",
6291
+ "value_allowed_null": false
6292
+ },
6293
+ {
6294
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
6295
+ "member": "string",
6296
+ "name": "RequestId",
6297
+ "type": "string"
6298
+ }
6299
+ ],
6300
+ "type": "object"
6301
+ },
6180
6302
  "UpdateIntegrationEmployeesRequest": {
6181
6303
  "document": "UpdateIntegrationEmployees请求参数结构体",
6182
6304
  "members": [
@@ -1,5 +1,19 @@
1
1
  {
2
2
  "actions": {
3
+ "BindEmployeeUserIdWithClientOpenId": [
4
+ {
5
+ "document": "",
6
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BindEmployeeUserIdWithClientOpenId\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ProxyIp\": \"\",\n \"ClientIp\": \"0.0.0.1\",\n \"UserId\": \"\",\n \"Channel\": \"CLOUD_API\",\n \"OpenId\": \"12345\"\n },\n \"UserId\": \"************\",\n \"OpenId\": \"***********\"\n}",
7
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s1665218505798774974\",\n \"Status\": 1\n }\n}",
8
+ "title": "示例1"
9
+ },
10
+ {
11
+ "document": "",
12
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BindEmployeeUserIdWithClientOpenId\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ProxyIp\": \"\",\n \"ClientIp\": \"0.0.0.1\",\n \"UserId\": \"**************\",\n \"Channel\": \"\",\n \"OpenId\": \"\"\n },\n \"UserId\": \"************\",\n \"OpenId\": \"***********\"\n}",
13
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s1665218590874024539\",\n \"Status\": 1\n }\n}",
14
+ "title": "示例2"
15
+ }
16
+ ],
3
17
  "CancelFlow": [
4
18
  {
5
19
  "document": "撤销单个签署流程",
@@ -374,6 +388,20 @@
374
388
  "title": "发起流程"
375
389
  }
376
390
  ],
391
+ "UnbindEmployeeUserIdWithClientOpenId": [
392
+ {
393
+ "document": "",
394
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UnbindEmployeeUserIdWithClientOpenId\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ProxyIp\": \"\",\n \"ClientIp\": \"0.0.0.1\",\n \"UserId\": \"\",\n \"Channel\": \"CLOUD_API\",\n \"OpenId\": \"12345\"\n },\n \"UserId\": \"************\",\n \"OpenId\": \"***********\"\n}",
395
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s1665384640598336866\",\n \"Status\": 1\n }\n}",
396
+ "title": "示例1"
397
+ },
398
+ {
399
+ "document": "",
400
+ "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UnbindEmployeeUserIdWithClientOpenId\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ProxyIp\": \"\",\n \"ClientIp\": \"0.0.0.1\",\n \"UserId\": \"**************\",\n \"Channel\": \"\",\n \"OpenId\": \"\"\n },\n \"UserId\": \"************\",\n \"OpenId\": \"***********\"\n}",
401
+ "output": "{\n \"Response\": {\n \"RequestId\": \"s1665218558695032958\",\n \"Status\": 1\n }\n}",
402
+ "title": "示例2"
403
+ }
404
+ ],
377
405
  "UpdateIntegrationEmployees": [
378
406
  {
379
407
  "document": "更新员工名称,手机号",
@@ -2970,17 +2970,24 @@
2970
2970
  "document": "意愿核身问答模式结果",
2971
2971
  "members": [
2972
2972
  {
2973
- "default": "",
2974
- "document": "意愿核身最终结果:\n0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验\n注意:此字段可能返回 null,表示取不到有效值。",
2975
- "example": "0",
2973
+ "document": "意愿核身错误码:\n0: \"成功\" \n-1: \"参数错误\" \n-2: \"系统异常\" \n-101: \"请保持人脸在框内\" \n-102: \"检测到多张人脸\" \n-103: \"人脸检测失败\" \n-104: \"人脸检测不完整\" \n-105: \"请勿遮挡眼睛\" \n-106: \"请勿遮挡嘴巴\" \n-107: \"请勿遮挡鼻子\" \n-201: \"人脸比对相似度低\" \n-202: \"人脸比对失败\" \n-301: \"意愿核验不通过\" \n-800: \"前端不兼容错误\" \n-801: \"用户未授权摄像头和麦克风权限\" \n-802: \"获取视频流失败\" \n-803: \"用户主动关闭链接/异常断开链接\" \n-998: \"系统数据异常\" \n-999: \"系统未知错误,请联系人工核实\" \n注意:此字段可能返回 null,表示取不到有效值。",
2974
+ "example": "",
2975
+ "member": "int64",
2976
+ "name": "FinalResultDetailCode",
2977
+ "required": false,
2978
+ "type": "int",
2979
+ "value_allowed_null": true
2980
+ },
2981
+ {
2982
+ "document": "意愿核身错误信息\n注意:此字段可能返回 null,表示取不到有效值。",
2983
+ "example": "无",
2976
2984
  "member": "string",
2977
- "name": "FinalResultCode",
2978
- "required": true,
2985
+ "name": "FinalResultMessage",
2986
+ "required": false,
2979
2987
  "type": "string",
2980
2988
  "value_allowed_null": true
2981
2989
  },
2982
2990
  {
2983
- "default": "",
2984
2991
  "document": "视频base64(其中包含全程问题和回答音频,mp4格式)\n注意:此字段可能返回 null,表示取不到有效值。",
2985
2992
  "example": "无",
2986
2993
  "member": "string",
@@ -2990,7 +2997,6 @@
2990
2997
  "value_allowed_null": true
2991
2998
  },
2992
2999
  {
2993
- "default": "",
2994
3000
  "document": "屏幕截图base64列表\n注意:此字段可能返回 null,表示取不到有效值。",
2995
3001
  "example": "无",
2996
3002
  "member": "string",
@@ -3000,7 +3006,6 @@
3000
3006
  "value_allowed_null": true
3001
3007
  },
3002
3008
  {
3003
- "default": "",
3004
3009
  "document": "和答案匹配结果列表\n0:成功,-1:不匹配\n注意:此字段可能返回 null,表示取不到有效值。",
3005
3010
  "example": "0",
3006
3011
  "member": "string",
@@ -3010,7 +3015,6 @@
3010
3015
  "value_allowed_null": true
3011
3016
  },
3012
3017
  {
3013
- "default": "",
3014
3018
  "document": "回答问题语音识别结果列表\n注意:此字段可能返回 null,表示取不到有效值。",
3015
3019
  "example": "无",
3016
3020
  "member": "string",
@@ -3020,7 +3024,6 @@
3020
3024
  "value_allowed_null": true
3021
3025
  },
3022
3026
  {
3023
- "default": "",
3024
3027
  "document": "答案录音音频\n注意:此字段可能返回 null,表示取不到有效值。",
3025
3028
  "example": "无",
3026
3029
  "member": "string",
@@ -3028,6 +3031,15 @@
3028
3031
  "required": true,
3029
3032
  "type": "list",
3030
3033
  "value_allowed_null": true
3034
+ },
3035
+ {
3036
+ "document": "意愿核身最终结果:\n0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3037
+ "example": "0",
3038
+ "member": "string",
3039
+ "name": "FinalResultCode",
3040
+ "required": true,
3041
+ "type": "string",
3042
+ "value_allowed_null": true
3031
3043
  }
3032
3044
  ],
3033
3045
  "usage": "out"
@@ -4,7 +4,7 @@
4
4
  {
5
5
  "document": "图片同步检测",
6
6
  "input": "POST / HTTP/1.1\nHost: ims.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ImageModeration\n<公共请求参数>\n\n{\n \"BizType\": \"test_1001\",\n \"DataId\": \"1213\",\n \"FileUrl\": \"https://xxx.jpg\"\n}",
7
- "output": "{\n \"Response\": {\n \"RequestId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"DataId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"BizType\": \"test_1001\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"HitFlag\": 1,\n \"LabelResults\": [\n {\n \"Scene\": \"Porn\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"Details\": [\n {\n \"Id\": 0,\n \"Name\": \"SexBehavior\",\n \"Score\": 90\n }\n ]\n }\n ],\n \"ObjectResults\": [\n {\n \"Scene\": \"QrCode\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Ad\",\n \"SubLabel\": \"\",\n \"Score\": 100,\n \"Names\": [\n \"QRCODE\"\n ],\n \"Details\": [\n {\n \"Id\": 0,\n \"Name\": \"QRCODE\",\n \"Score\": 100,\n \"Location\": {\n \"X\": 155.01746,\n \"Y\": 396.01746,\n \"Width\": 769.9824,\n \"Height\": 769.98254,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"OcrResults\": [\n {\n \"HitFlag\": 0,\n \"Scene\": \"OCR\",\n \"Suggestion\": \"Pass\",\n \"Label\": \"Normal\",\n \"SubLabel\": \"\",\n \"Score\": 0,\n \"Text\": \"hello world\",\n \"Details\": [\n {\n \"Text\": \"hello world\",\n \"Label\": \"\",\n \"LibId\": \"\",\n \"LibName\": \"\",\n \"Keywords\": [],\n \"Rate\": 0,\n \"Score\": 0,\n \"Location\": {\n \"X\": 8,\n \"Y\": 0,\n \"Width\": 111,\n \"Height\": 19,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"LibResults\": [\n {\n \"Scene\": \"Similar\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"\",\n \"Score\": 99,\n \"Details\": [\n {\n \"LibName\": \"123\",\n \"Score\": 99,\n \"Label\": \"Porn\",\n \"Tag\": \"\",\n \"ImageId\": \"111\",\n \"Id\": 0,\n \"LibId\": \"\"\n }\n ],\n \"Suggestion\": \"Block\"\n }\n ],\n \"Extra\": \"\"\n }\n}",
7
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"DataId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"BizType\": \"test_1001\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"HitFlag\": 1,\n \"LabelResults\": [\n {\n \"Scene\": \"Porn\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"Details\": [\n {\n \"Id\": 0,\n \"Name\": \"SexBehavior\",\n \"Score\": 90\n }\n ]\n }\n ],\n \"ObjectResults\": [\n {\n \"Scene\": \"QrCode\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Ad\",\n \"SubLabel\": \"\",\n \"Score\": 100,\n \"Names\": [\n \"QRCODE\"\n ],\n \"Details\": [\n {\n \"Id\": 0,\n \"Name\": \"QRCODE\",\n \"Value\": \"https://test.com/test\",\n \"Score\": 100,\n \"Location\": {\n \"X\": 155.01746,\n \"Y\": 396.01746,\n \"Width\": 769.9824,\n \"Height\": 769.98254,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"OcrResults\": [\n {\n \"HitFlag\": 0,\n \"Scene\": \"OCR\",\n \"Suggestion\": \"Pass\",\n \"Label\": \"Normal\",\n \"SubLabel\": \"\",\n \"Score\": 0,\n \"Text\": \"hello world\",\n \"Details\": [\n {\n \"Text\": \"hello world\",\n \"Label\": \"\",\n \"LibId\": \"\",\n \"LibName\": \"\",\n \"Keywords\": [],\n \"Rate\": 0,\n \"Score\": 0,\n \"Location\": {\n \"X\": 8,\n \"Y\": 0,\n \"Width\": 111,\n \"Height\": 19,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"LibResults\": [\n {\n \"Scene\": \"Similar\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"\",\n \"Score\": 99,\n \"Details\": [\n {\n \"LibName\": \"123\",\n \"Score\": 99,\n \"Label\": \"Porn\",\n \"Tag\": \"\",\n \"ImageId\": \"111\",\n \"Id\": 0,\n \"LibId\": \"\"\n }\n ],\n \"Suggestion\": \"Block\"\n }\n ],\n \"Extra\": \"\"\n }\n}",
8
8
  "title": "图片同步检测"
9
9
  }
10
10
  ]
@@ -12,7 +12,7 @@
12
12
  {
13
13
  "document": "图片同步检测",
14
14
  "input": "POST / HTTP/1.1\nHost: ims.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ImageModeration\n<公共请求参数>\n\n{\n \"BizType\": \"test_1001\",\n \"DataId\": \"1213\",\n \"FileUrl\": \"https://xxx.jpg\"\n}",
15
- "output": "{\n \"Response\": {\n \"RequestId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"DataId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"BizType\": \"test_1001\",\n \"Suggestion\": \"Block\",\n \"FileMD5\": \"\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"LabelResults\": [\n {\n \"Scene\": \"Porn\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"Details\": []\n }\n ],\n \"ObjectResults\": [\n {\n \"Scene\": \"QrCode\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Ad\",\n \"SubLabel\": \"\",\n \"Score\": 100,\n \"Names\": [\n \"QRCODE\"\n ],\n \"Details\": [\n {\n \"Id\": 0,\n \"Name\": \"QRCODE\",\n \"Score\": 100,\n \"Location\": {\n \"X\": 155.01746,\n \"Y\": 396.01746,\n \"Width\": 769.9824,\n \"Height\": 769.98254,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"OcrResults\": [],\n \"LibResults\": [],\n \"RecognitionResults\": [\n {\n \"Label\": \"Scene\",\n \"Tags\": [\n {\n \"Name\": \"MedicalImage\",\n \"Score\": 30,\n \"Location\": {\n \"X\": 0,\n \"Y\": 0,\n \"Width\": 0,\n \"Height\": 0,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"Extra\": \"\"\n }\n}",
15
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"DataId\": \"a61237dd-c2a0-43e7-a3da-d27022d39ba7\",\n \"BizType\": \"test_1001\",\n \"Suggestion\": \"Block\",\n \"FileMD5\": \"\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"LabelResults\": [\n {\n \"Scene\": \"Porn\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Porn\",\n \"SubLabel\": \"SexBehavior\",\n \"Score\": 90,\n \"Details\": []\n }\n ],\n \"ObjectResults\": [\n {\n \"Scene\": \"QrCode\",\n \"Suggestion\": \"Block\",\n \"Label\": \"Ad\",\n \"SubLabel\": \"\",\n \"Score\": 100,\n \"Names\": [\n \"QRCODE\"\n ],\n \"Details\": [\n {\n \"Id\": 0,\n \"Name\": \"QRCODE\",\n \"Value\": \"https://test.com/test\",\n \"SubLabel\": \"QRCODE\",\n \"Score\": 100,\n \"Location\": {\n \"X\": 155.01746,\n \"Y\": 396.01746,\n \"Width\": 769.9824,\n \"Height\": 769.98254,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"OcrResults\": [],\n \"LibResults\": [],\n \"RecognitionResults\": [\n {\n \"Label\": \"Scene\",\n \"Tags\": [\n {\n \"Name\": \"MedicalImage\",\n \"Score\": 30,\n \"Location\": {\n \"X\": 0,\n \"Y\": 0,\n \"Width\": 0,\n \"Height\": 0,\n \"Rotate\": 0\n }\n }\n ]\n }\n ],\n \"Extra\": \"\"\n }\n}",
16
16
  "title": "图片同步检测"
17
17
  }
18
18
  ]
@@ -43,11 +43,11 @@
43
43
  "status": "online"
44
44
  },
45
45
  "DeleteScanInstances": {
46
- "document": "删除一个或者多个app扫描信息",
46
+ "document": "由于该产品是线上免费使用产品,无企业版用户,升级迭代成本高及人力安排等原因,安全测评产品不再接入新用户,故下线。\n\n删除一个或者多个app扫描信息",
47
47
  "input": "DeleteScanInstancesRequest",
48
48
  "name": "批量删除提交过的app扫描信息",
49
49
  "output": "DeleteScanInstancesResponse",
50
- "status": "online"
50
+ "status": "deprecated"
51
51
  },
52
52
  "DeleteShieldInstances": {
53
53
  "document": "删除一个或者多个app加固信息。(注意:根据国家互联网用户实名制相关要求,使用该产品前,需先完成实名认证。)",