tccli 3.0.1369.1__py2.py3-none-any.whl → 3.0.1371.1__py2.py3-none-any.whl
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.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +4 -3
- tccli/services/cfs/cfs_client.py +61 -8
- tccli/services/cfs/v20190719/api.json +71 -0
- tccli/services/cfs/v20190719/examples.json +8 -0
- tccli/services/cls/v20201016/api.json +27 -27
- tccli/services/cls/v20201016/examples.json +4 -4
- tccli/services/ctem/v20231128/api.json +8 -8
- tccli/services/ctem/v20231128/examples.json +2 -2
- tccli/services/dcdb/v20180411/api.json +31 -2
- tccli/services/dcdb/v20180411/examples.json +1 -1
- tccli/services/dlc/v20210125/api.json +17 -7
- tccli/services/dsgc/v20190723/api.json +8 -8
- tccli/services/dsgc/v20190723/examples.json +1 -1
- tccli/services/es/v20180416/examples.json +3 -3
- tccli/services/ess/v20201111/api.json +30 -6
- tccli/services/ess/v20201111/examples.json +1 -1
- tccli/services/essbasic/v20210526/api.json +24 -0
- tccli/services/faceid/v20180301/api.json +42 -2
- tccli/services/faceid/v20180301/examples.json +2 -2
- tccli/services/lighthouse/v20200324/api.json +1 -1
- tccli/services/lke/v20231130/api.json +3 -3
- tccli/services/mariadb/v20170312/api.json +30 -1
- tccli/services/mariadb/v20170312/examples.json +1 -1
- tccli/services/mongodb/v20180408/api.json +1 -1
- tccli/services/mongodb/v20190725/api.json +1 -1
- tccli/services/organization/organization_client.py +53 -0
- tccli/services/organization/v20210331/api.json +175 -0
- tccli/services/organization/v20210331/examples.json +8 -0
- tccli/services/privatedns/v20201028/api.json +7 -7
- tccli/services/sqlserver/v20180328/api.json +11 -9
- tccli/services/tione/v20211111/api.json +1 -1
- tccli/services/trocket/v20230308/api.json +9 -0
- tccli/services/tsf/v20180326/api.json +6 -6
- {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/RECORD +39 -39
- {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1369.1.dist-info → tccli-3.0.1371.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -2960,6 +2960,16 @@
|
|
|
2960
2960
|
"output_required": true,
|
|
2961
2961
|
"type": "string",
|
|
2962
2962
|
"value_allowed_null": false
|
|
2963
|
+
},
|
|
2964
|
+
{
|
|
2965
|
+
"disabled": false,
|
|
2966
|
+
"document": "实例删除保护标签，1: 已开启删除保护，0: 未开启删除保护",
|
|
2967
|
+
"example": "1",
|
|
2968
|
+
"member": "int64",
|
|
2969
|
+
"name": "ProtectedProperty",
|
|
2970
|
+
"output_required": true,
|
|
2971
|
+
"type": "int",
|
|
2972
|
+
"value_allowed_null": false
|
|
2963
2973
|
}
|
|
2964
2974
|
],
|
|
2965
2975
|
"usage": "out"
|
|
@@ -5363,6 +5373,16 @@
|
|
|
5363
5373
|
"type": "string",
|
|
5364
5374
|
"value_allowed_null": false
|
|
5365
5375
|
},
|
|
5376
|
+
{
|
|
5377
|
+
"disabled": false,
|
|
5378
|
+
"document": "实例删除保护标签，1: 已开启删除保护，0: 未开启删除保护",
|
|
5379
|
+
"example": "1",
|
|
5380
|
+
"member": "int64",
|
|
5381
|
+
"name": "ProtectedProperty",
|
|
5382
|
+
"output_required": true,
|
|
5383
|
+
"type": "int",
|
|
5384
|
+
"value_allowed_null": false
|
|
5385
|
+
},
|
|
5366
5386
|
{
|
|
5367
5387
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
5368
5388
|
"member": "string",
|
|
@@ -7465,6 +7485,15 @@
|
|
|
7465
7485
|
"name": "ShardSerialId",
|
|
7466
7486
|
"required": false,
|
|
7467
7487
|
"type": "string"
|
|
7488
|
+
},
|
|
7489
|
+
{
|
|
7490
|
+
"disabled": false,
|
|
7491
|
+
"document": "节点ID，可指定主节点或者备节点进行kill。可选参数，不传默认为主节点。",
|
|
7492
|
+
"example": "681390887981",
|
|
7493
|
+
"member": "string",
|
|
7494
|
+
"name": "NodeId",
|
|
7495
|
+
"required": false,
|
|
7496
|
+
"type": "string"
|
|
7468
7497
|
}
|
|
7469
7498
|
],
|
|
7470
7499
|
"type": "object"
|
|
@@ -7922,7 +7951,7 @@
|
|
|
7922
7951
|
},
|
|
7923
7952
|
{
|
|
7924
7953
|
"disabled": false,
|
|
7925
|
-
"document": "要修改的安全组 ID 列表，一个或者多个安全组 ID
|
|
7954
|
+
"document": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。<br>注意：该入参会全量替换存量已有安全组集合，并非增量更新。修改需传入全量的预期集合。",
|
|
7926
7955
|
"example": "[\"sg-ajr1jzgj\\n\"]",
|
|
7927
7956
|
"member": "string",
|
|
7928
7957
|
"name": "SecurityGroupIds",
|
|
@@ -8234,7 +8263,7 @@
|
|
|
8234
8263
|
{
|
|
8235
8264
|
"disabled": false,
|
|
8236
8265
|
"document": "实例ID",
|
|
8237
|
-
"example": "
|
|
8266
|
+
"example": "tdsqlshard-xxx",
|
|
8238
8267
|
"member": "string",
|
|
8239
8268
|
"name": "InstanceId",
|
|
8240
8269
|
"required": true,
|
|
@@ -242,7 +242,7 @@
|
|
|
242
242
|
{
|
|
243
243
|
"document": "本接口用于查询实例详细信息",
|
|
244
244
|
"input": "POST / HTTP/1.1\nHost: dcdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDCDBInstanceDetail\n<公共请求参数>\n\n{\n \"InstanceId\": \"tdsqlshard-hn35cf0n\"\n}",
|
|
245
|
-
"output": "{\n \"Response\": {\n \"AutoRenewFlag\": 0,\n \"Cpu\": 2,\n \"CpuType\": \"Intel/AMD\",\n \"CreateTime\": \"2025-03-22 17:01:11\",\n \"DbEngine\": \"MySQL\",\n \"DbVersion\": \"8.0.30\",\n \"DbVersionId\": \"8.0\",\n \"DcnDstNum\": 0,\n \"DcnFlag\": 0,\n \"DcnStatus\": 0,\n \"EncryptStatus\": 0,\n \"ExclusterId\": \"dbdc-00wb5kz5\",\n \"ExclusterType\": 0,\n \"InstanceId\": \"tdsqlshard-hn35cf0n\",\n \"InstanceName\": \"QT4st6gv8.0\",\n \"InstanceType\": 1,\n \"Ipv6Flag\": 0,\n \"IsAuditSupported\": 1,\n \"IsDcnStrongSyncSupported\": 0,\n \"IsDcnSwitchSupported\": 1,\n \"IsEncryptSupported\": 1,\n \"IsMaxUserConnectionsSupported\": true,\n \"IsPhysicalReplicationSupported\": false,\n \"LogStorage\": 16,\n \"Machine\": \"SH12\",\n \"MasterZone\": \"ap-guangzhou-2\",\n \"Memory\": 4,\n \"NodeCount\": 2,\n \"PayMode\": \"prepaid\",\n \"PeriodEndTime\": \"2025-03-28 15:33:44\",\n \"Pid\": 11128,\n \"ProjectId\": 0,\n \"Qps\": 2100,\n \"Region\": \"ap-guangzhou\",\n \"RequestId\": \"37f48ae6-6e19-421c-bc3d-9e5215bce840\",\n \"ReservedNetResources\": [],\n \"ResourceTags\": [],\n \"RsAccessStrategy\": 0,\n \"Shards\": [\n {\n \"Cpu\": 1,\n \"CreateTime\": \"2025-03-22 17:01:12\",\n \"LogDisk\": 8,\n \"Memory\": 2,\n \"NodeCount\": 2,\n \"NodesInfo\": [\n {\n \"NodeId\": \"412f4810600c\",\n \"Role\": \"master\",\n \"Zone\": \"ap-guangzhou-2\"\n },\n {\n \"NodeId\": \"a0872cc18e43\",\n \"Role\": \"slave\",\n \"Zone\": \"ap-guangzhou-2\"\n }\n ],\n \"ProxyVersion\": \"\",\n \"ShardInstanceId\": \"shard-alt5mizl\",\n \"ShardMasterZone\": \"ap-guangzhou-2\",\n \"ShardSerialId\": \"set_1742635118_5\",\n \"ShardSlaveZones\": [\n \"ap-guangzhou-2\"\n ],\n \"Status\": 2,\n \"StatusDesc\": \"运行中\",\n \"Storage\": 10,\n \"StorageUsage\": 0.01\n },\n {\n \"Cpu\": 1,\n \"CreateTime\": \"2025-03-22 17:01:12\",\n \"LogDisk\": 8,\n \"Memory\": 2,\n \"NodeCount\": 2,\n \"NodesInfo\": [\n {\n \"NodeId\": \"557c152b5be8\",\n \"Role\": \"master\",\n \"Zone\": \"ap-guangzhou-2\"\n },\n {\n \"NodeId\": \"5fa1b08b00e8\",\n \"Role\": \"slave\",\n \"Zone\": \"ap-guangzhou-2\"\n }\n ],\n \"ProxyVersion\": \"\",\n \"ShardInstanceId\": \"shard-l4vjg0a3\",\n \"ShardMasterZone\": \"ap-guangzhou-2\",\n \"ShardSerialId\": \"set_1742635315_7\",\n \"ShardSlaveZones\": [\n \"ap-guangzhou-2\"\n ],\n \"Status\": 2,\n \"StatusDesc\": \"运行中\",\n \"Storage\": 10,\n \"StorageUsage\": 0.01\n }\n ],\n \"SlaveZones\": [\n \"ap-guangzhou-2\"\n ],\n \"Status\": 2,\n \"StatusDesc\": \"运行中\",\n \"Storage\": 20,\n \"StorageUsage\": 0.01,\n \"SubnetId\": \"subnet-6rq8ehaq\",\n \"Vip\": \"10.0.0.50\",\n \"Vip6\": \"\",\n \"VpcId\": \"vpc-ilhphh7v\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanPort\": 0,\n \"WanPortIpv6\": 0,\n \"WanStatus\": 0,\n \"WanStatusIpv6\": 0,\n \"WanVip\": \"\",\n \"WanVipv6\": \"\"\n }\n}",
|
|
245
|
+
"output": "{\n \"Response\": {\n \"AutoRenewFlag\": 0,\n \"Cpu\": 2,\n \"CpuType\": \"Intel/AMD\",\n \"CreateTime\": \"2025-03-22 17:01:11\",\n \"DbEngine\": \"MySQL\",\n \"DbVersion\": \"8.0.30\",\n \"DbVersionId\": \"8.0\",\n \"DcnDstNum\": 0,\n \"DcnFlag\": 0,\n \"DcnStatus\": 0,\n \"EncryptStatus\": 0,\n \"ExclusterId\": \"dbdc-00wb5kz5\",\n \"ExclusterType\": 0,\n \"InstanceId\": \"tdsqlshard-hn35cf0n\",\n \"InstanceName\": \"QT4st6gv8.0\",\n \"InstanceType\": 1,\n \"Ipv6Flag\": 0,\n \"IsAuditSupported\": 1,\n \"IsDcnStrongSyncSupported\": 0,\n \"IsDcnSwitchSupported\": 1,\n \"IsEncryptSupported\": 1,\n \"IsMaxUserConnectionsSupported\": true,\n \"IsPhysicalReplicationSupported\": false,\n \"LogStorage\": 16,\n \"Machine\": \"SH12\",\n \"MasterZone\": \"ap-guangzhou-2\",\n \"Memory\": 4,\n \"NodeCount\": 2,\n \"PayMode\": \"prepaid\",\n \"PeriodEndTime\": \"2025-03-28 15:33:44\",\n \"Pid\": 11128,\n \"ProjectId\": 0,\n \"Qps\": 2100,\n \"Region\": \"ap-guangzhou\",\n \"RequestId\": \"37f48ae6-6e19-421c-bc3d-9e5215bce840\",\n \"ReservedNetResources\": [],\n \"ResourceTags\": [],\n \"RsAccessStrategy\": 0,\n \"Shards\": [\n {\n \"Cpu\": 1,\n \"CreateTime\": \"2025-03-22 17:01:12\",\n \"LogDisk\": 8,\n \"Memory\": 2,\n \"NodeCount\": 2,\n \"NodesInfo\": [\n {\n \"NodeId\": \"412f4810600c\",\n \"Role\": \"master\",\n \"Zone\": \"ap-guangzhou-2\"\n },\n {\n \"NodeId\": \"a0872cc18e43\",\n \"Role\": \"slave\",\n \"Zone\": \"ap-guangzhou-2\"\n }\n ],\n \"ProxyVersion\": \"\",\n \"ShardInstanceId\": \"shard-alt5mizl\",\n \"ShardMasterZone\": \"ap-guangzhou-2\",\n \"ShardSerialId\": \"set_1742635118_5\",\n \"ShardSlaveZones\": [\n \"ap-guangzhou-2\"\n ],\n \"Status\": 2,\n \"StatusDesc\": \"运行中\",\n \"Storage\": 10,\n \"StorageUsage\": 0.01\n },\n {\n \"Cpu\": 1,\n \"CreateTime\": \"2025-03-22 17:01:12\",\n \"LogDisk\": 8,\n \"Memory\": 2,\n \"NodeCount\": 2,\n \"NodesInfo\": [\n {\n \"NodeId\": \"557c152b5be8\",\n \"Role\": \"master\",\n \"Zone\": \"ap-guangzhou-2\"\n },\n {\n \"NodeId\": \"5fa1b08b00e8\",\n \"Role\": \"slave\",\n \"Zone\": \"ap-guangzhou-2\"\n }\n ],\n \"ProxyVersion\": \"\",\n \"ShardInstanceId\": \"shard-l4vjg0a3\",\n \"ShardMasterZone\": \"ap-guangzhou-2\",\n \"ShardSerialId\": \"set_1742635315_7\",\n \"ShardSlaveZones\": [\n \"ap-guangzhou-2\"\n ],\n \"Status\": 2,\n \"StatusDesc\": \"运行中\",\n \"Storage\": 10,\n \"StorageUsage\": 0.01\n }\n ],\n \"SlaveZones\": [\n \"ap-guangzhou-2\"\n ],\n \"Status\": 2,\n \"StatusDesc\": \"运行中\",\n \"Storage\": 20,\n \"StorageUsage\": 0.01,\n \"SubnetId\": \"subnet-6rq8ehaq\",\n \"Vip\": \"10.0.0.50\",\n \"Vip6\": \"\",\n \"VpcId\": \"vpc-ilhphh7v\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanPort\": 0,\n \"WanPortIpv6\": 0,\n \"WanStatus\": 0,\n \"WanStatusIpv6\": 0,\n \"WanVip\": \"\",\n \"WanVipv6\": \"\",\n \"ProtectedProperty\": 1\n }\n}",
|
|
246
246
|
"title": "获取实例详情"
|
|
247
247
|
}
|
|
248
248
|
],
|
|
@@ -3609,7 +3609,7 @@
|
|
|
3609
3609
|
},
|
|
3610
3610
|
{
|
|
3611
3611
|
"disabled": false,
|
|
3612
|
-
"document": "资源使用时长，后付费：固定填
|
|
3612
|
+
"document": "资源使用时长，后付费：固定填1，预付费：最少填1，代表购买资源一个月，最长不超过120。默认1",
|
|
3613
3613
|
"example": "1",
|
|
3614
3614
|
"member": "int64",
|
|
3615
3615
|
"name": "TimeSpan",
|
|
@@ -3618,7 +3618,7 @@
|
|
|
3618
3618
|
},
|
|
3619
3619
|
{
|
|
3620
3620
|
"disabled": false,
|
|
3621
|
-
"document": "资源使用时长的单位，后付费：
|
|
3621
|
+
"document": "资源使用时长的单位，后付费：h，预付费：m。默认为h",
|
|
3622
3622
|
"example": "s",
|
|
3623
3623
|
"member": "string",
|
|
3624
3624
|
"name": "TimeUnit",
|
|
@@ -3672,7 +3672,7 @@
|
|
|
3672
3672
|
},
|
|
3673
3673
|
{
|
|
3674
3674
|
"disabled": false,
|
|
3675
|
-
"document": "引擎执行任务类型，有效值：SQL/BATCH
|
|
3675
|
+
"document": "引擎执行任务类型，有效值：SQL/BATCH，标准引擎默认为BATCH",
|
|
3676
3676
|
"example": "SQL/BATCH",
|
|
3677
3677
|
"member": "string",
|
|
3678
3678
|
"name": "EngineExecType",
|
|
@@ -21988,7 +21988,7 @@
|
|
|
21988
21988
|
{
|
|
21989
21989
|
"disabled": false,
|
|
21990
21990
|
"document": "任务输出路径。",
|
|
21991
|
-
"example": "cosn://test-bucket-
|
|
21991
|
+
"example": "cosn://test-bucket-1/result/",
|
|
21992
21992
|
"member": "string",
|
|
21993
21993
|
"name": "OutputPath",
|
|
21994
21994
|
"output_required": true,
|
|
@@ -22088,7 +22088,7 @@
|
|
|
22088
22088
|
{
|
|
22089
22089
|
"disabled": false,
|
|
22090
22090
|
"document": "任务执行输出信息。",
|
|
22091
|
-
"example": "Invalid compression codec: ,Available codecs are none,bzip2
|
|
22091
|
+
"example": "Invalid compression codec: ,Available codecs are none,bzip2",
|
|
22092
22092
|
"member": "string",
|
|
22093
22093
|
"name": "OutputMessage",
|
|
22094
22094
|
"output_required": true,
|
|
@@ -22318,7 +22318,7 @@
|
|
|
22318
22318
|
{
|
|
22319
22319
|
"disabled": false,
|
|
22320
22320
|
"document": "任务公共指标数据\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
22321
|
-
"example": "
|
|
22321
|
+
"example": "无",
|
|
22322
22322
|
"member": "CommonMetrics",
|
|
22323
22323
|
"name": "CommonMetrics",
|
|
22324
22324
|
"output_required": true,
|
|
@@ -22328,7 +22328,7 @@
|
|
|
22328
22328
|
{
|
|
22329
22329
|
"disabled": false,
|
|
22330
22330
|
"document": "spark任务指标数据\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
22331
|
-
"example": "
|
|
22331
|
+
"example": "无",
|
|
22332
22332
|
"member": "SparkMonitorMetrics",
|
|
22333
22333
|
"name": "SparkMonitorMetrics",
|
|
22334
22334
|
"output_required": true,
|
|
@@ -22374,6 +22374,16 @@
|
|
|
22374
22374
|
"output_required": false,
|
|
22375
22375
|
"type": "string",
|
|
22376
22376
|
"value_allowed_null": false
|
|
22377
|
+
},
|
|
22378
|
+
{
|
|
22379
|
+
"disabled": false,
|
|
22380
|
+
"document": "任务执行耗时",
|
|
22381
|
+
"example": "1206",
|
|
22382
|
+
"member": "int64",
|
|
22383
|
+
"name": "JobTimeSum",
|
|
22384
|
+
"output_required": false,
|
|
22385
|
+
"type": "int",
|
|
22386
|
+
"value_allowed_null": false
|
|
22377
22387
|
}
|
|
22378
22388
|
],
|
|
22379
22389
|
"usage": "out"
|
|
@@ -400,7 +400,7 @@
|
|
|
400
400
|
"status": "online"
|
|
401
401
|
},
|
|
402
402
|
"DescribeDSPAAssessmentTemplateControlItems": {
|
|
403
|
-
"document": "获取DSPA
|
|
403
|
+
"document": "获取DSPA评估模板关联的评估控制项列表",
|
|
404
404
|
"input": "DescribeDSPAAssessmentTemplateControlItemsRequest",
|
|
405
405
|
"name": "获取DSPA评估模板关联控制项列表",
|
|
406
406
|
"output": "DescribeDSPAAssessmentTemplateControlItemsResponse",
|
|
@@ -1397,7 +1397,7 @@
|
|
|
1397
1397
|
{
|
|
1398
1398
|
"disabled": false,
|
|
1399
1399
|
"document": "关联模板列表",
|
|
1400
|
-
"example": "[{\"TemplateId\":10,\"TemplateName\":\"
|
|
1400
|
+
"example": "[{\"TemplateId\":10,\"TemplateName\":\"风险模板\"}]",
|
|
1401
1401
|
"member": "TemplateInfo",
|
|
1402
1402
|
"name": "ReferTemplateList",
|
|
1403
1403
|
"output_required": true,
|
|
@@ -3431,7 +3431,7 @@
|
|
|
3431
3431
|
},
|
|
3432
3432
|
{
|
|
3433
3433
|
"disabled": false,
|
|
3434
|
-
"document": "1
|
|
3434
|
+
"document": "1代表模板开启，0代表模板关闭",
|
|
3435
3435
|
"example": "1",
|
|
3436
3436
|
"member": "int64",
|
|
3437
3437
|
"name": "Status",
|
|
@@ -8689,7 +8689,7 @@
|
|
|
8689
8689
|
},
|
|
8690
8690
|
{
|
|
8691
8691
|
"disabled": false,
|
|
8692
|
-
"document": "
|
|
8692
|
+
"document": "是否仅显示已开启模板",
|
|
8693
8693
|
"example": "false",
|
|
8694
8694
|
"member": "bool",
|
|
8695
8695
|
"name": "IsFilterCloseComplianceGroup",
|
|
@@ -8705,7 +8705,7 @@
|
|
|
8705
8705
|
{
|
|
8706
8706
|
"disabled": false,
|
|
8707
8707
|
"document": "合规组列表",
|
|
8708
|
-
"example": "[{
|
|
8708
|
+
"example": "[{\"ComplianceGroupId\": 15114, \"Name\": \"模板1\", \"Description\": \"\", \"ComplianceGroupType\": 2, \"ComplianceGroupRules\": null, \"LevelGroupId\": 1198, \"Disabled\": false, \"IsAlias\": false}]",
|
|
8709
8709
|
"member": "DspaDiscoveryComplianceGroupInfo",
|
|
8710
8710
|
"name": "Items",
|
|
8711
8711
|
"output_required": true,
|
|
@@ -12269,7 +12269,7 @@
|
|
|
12269
12269
|
},
|
|
12270
12270
|
{
|
|
12271
12271
|
"disabled": false,
|
|
12272
|
-
"document": "1
|
|
12272
|
+
"document": "1代表模板开启，0代表模板关闭",
|
|
12273
12273
|
"example": "1",
|
|
12274
12274
|
"member": "int64",
|
|
12275
12275
|
"name": "Status",
|
|
@@ -12279,7 +12279,7 @@
|
|
|
12279
12279
|
},
|
|
12280
12280
|
{
|
|
12281
12281
|
"disabled": false,
|
|
12282
|
-
"document": "
|
|
12282
|
+
"document": "模板最后修改时间",
|
|
12283
12283
|
"example": "2024-10-08 16:11:44",
|
|
12284
12284
|
"member": "string",
|
|
12285
12285
|
"name": "ModifyTime",
|
|
@@ -17632,7 +17632,7 @@
|
|
|
17632
17632
|
},
|
|
17633
17633
|
{
|
|
17634
17634
|
"disabled": false,
|
|
17635
|
-
"document": "
|
|
17635
|
+
"document": "报告模板名称",
|
|
17636
17636
|
"example": "数据资产报告",
|
|
17637
17637
|
"member": "string",
|
|
17638
17638
|
"name": "ReportTemplateName",
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
"CreateDSPAComplianceGroup": [
|
|
100
100
|
{
|
|
101
101
|
"document": "",
|
|
102
|
-
"input": "POST / HTTP/1.1\nHost: dsgc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDSPAComplianceGroup\n<公共请求参数>\n\n{\n \"LevelGroupId\": \"1\",\n \"DspaId\": \"dspa-001\",\n \"ComplianceGroupRules\": [\n {\n \"RuleId\": 2,\n \"CategoryId\": 3,\n \"LevelId\": 2\n }\n ],\n \"Name\": \"task\",\n \"Description\": \"
|
|
102
|
+
"input": "POST / HTTP/1.1\nHost: dsgc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDSPAComplianceGroup\n<公共请求参数>\n\n{\n \"LevelGroupId\": \"1\",\n \"DspaId\": \"dspa-001\",\n \"ComplianceGroupRules\": [\n {\n \"RuleId\": 2,\n \"CategoryId\": 3,\n \"LevelId\": 2\n }\n ],\n \"Name\": \"task\",\n \"Description\": \"分类分级模板描述\"\n}",
|
|
103
103
|
"output": "{\n \"Response\": {\n \"RequestId\": \"20569756-56ba-4a13-b545-e1528d5cb239\",\n \"ComplianceGroupId\": 1\n }\n}",
|
|
104
104
|
"title": "新增分类分级模板"
|
|
105
105
|
}
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
{
|
|
13
13
|
"document": "",
|
|
14
14
|
"input": "POST / HTTP/1.1\nHost: es.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateClusterSnapshot\n<公共请求参数>\n\n{\n \"InstanceId\": \"es-xxx\",\n \"SnapshotName\": \"es-xxx-test_20240912\",\n \"Indices\": \"kibana_sample_data_flights\"\n}",
|
|
15
|
-
"output": "{\n \"Response\": {\n \"InstanceId\": \"es-xxx\",\n \"RequestId\": \"
|
|
16
|
-
"title": "
|
|
15
|
+
"output": "{\n \"Response\": {\n \"InstanceId\": \"es-xxx\",\n \"RequestId\": \"16eaxxxx-xxxx-xxxx-xxxx-xxxxxe45ae3c\"\n }\n}",
|
|
16
|
+
"title": "集群快照手动创建"
|
|
17
17
|
}
|
|
18
18
|
],
|
|
19
19
|
"CreateCosMigrateToServerlessInstance": [
|
|
@@ -356,7 +356,7 @@
|
|
|
356
356
|
{
|
|
357
357
|
"document": "",
|
|
358
358
|
"input": "POST / HTTP/1.1\nHost: es.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RestoreClusterSnapshot\n<公共请求参数>\n\n{\n \"InstanceId\": \"es-qpzizjym\",\n \"Password\": \"pass\",\n \"RepositoryName\": \"ES_AUTO_BACKUP\",\n \"SnapshotName\": \"test1\",\n \"Indices\": \"testnew\",\n \"Partial\": \"true\",\n \"TargetInstanceId\": \"es-qpzizjym\"\n}",
|
|
359
|
-
"output": "{\n \"Response\": {\n \"InstanceId\": \"es-qpzizjym\",\n \"RequestId\": \"
|
|
359
|
+
"output": "{\n \"Response\": {\n \"InstanceId\": \"es-qpzizjym\",\n \"RequestId\": \"test1\"\n }\n}",
|
|
360
360
|
"title": "RestoreClusterSnapshot 恢复快照数据到集群"
|
|
361
361
|
}
|
|
362
362
|
],
|
|
@@ -337,7 +337,7 @@
|
|
|
337
337
|
"status": "online"
|
|
338
338
|
},
|
|
339
339
|
"CreatePartnerAutoSignAuthUrl": {
|
|
340
|
-
"document": "创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。\n\n如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)\n2. 已经在授权中或者授权成功的企业，无法重复授权\n3. 授权企业和被授权企业必须都是已认证企业\n4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。\n\n\n**该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**\n![image](https://qcloudimg.tencent-cloud.cn/raw/
|
|
340
|
+
"document": "创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。\n\n如果授权企业尚未开通企业自动签功能，该链接还将引导他们首先开通本企业的自动签服务\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)\n2. 已经在授权中或者授权成功的企业，无法重复授权\n3. 授权企业和被授权企业必须都是已认证企业\n4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。\n\n\n**该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**\n",
|
|
341
341
|
"input": "CreatePartnerAutoSignAuthUrlRequest",
|
|
342
342
|
"name": "创建他方自动签授权链接",
|
|
343
343
|
"output": "CreatePartnerAutoSignAuthUrlResponse",
|
|
@@ -617,7 +617,7 @@
|
|
|
617
617
|
"status": "online"
|
|
618
618
|
},
|
|
619
619
|
"DescribeIntegrationRoles": {
|
|
620
|
-
"document": "此接口（DescribeIntegrationRoles
|
|
620
|
+
"document": "此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。\n\n角色分为系统默认角色与企业自定义角色，其中系统默认角色不可以禁用、删除、编辑权限项，只可往默认角色中添加成员。企业自定义角色为企业根据自身需要新增的角色，可根据企业具体情况设置各个角色的权限，例如新增财务岗、销售岗等角色。\n\n企业版的系统默认角色包含如下角色：\n\n| 角色名称 | 角色描述 |\n|------------------------------|--------------------------------------------------------------------------|\n| 超级管理员（电子签业务最高权限，e.g.法务/业务负责人） | 所有功能和数据管理权限，只能设置一位超管。 |\n| IT信息管理员（IT系统负责人，e.g. CTO） | 组织员工、计费模块、应用模块等权限能力。 |\n| 企业合同管理员（企业法务负责人） | 企业全部合同管理、可申请出证等权限能力。 |\n| 企业模板管理员 | 企业全部模板管理权限能力。 |\n| 企业印章管理员（企业行政负责人） | 管理企业的所有电子印章，如添加印章、启用停用印章、印章授权等。 |\n| 用印审批岗（各部门的印章管理岗） | 可对被授权的印章进行日常使用管理，如合同盖章用印的审核及登记。 |\n| 部门管理员（部门的合同+印章+模板管理） | 部门级（含子部门）所有合同管理权限能力。 |\n| 业务员（销售员、采购员） | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力。 |",
|
|
621
621
|
"input": "DescribeIntegrationRolesRequest",
|
|
622
622
|
"name": "查询企业角色列表",
|
|
623
623
|
"output": "DescribeIntegrationRolesResponse",
|
|
@@ -6955,7 +6955,7 @@
|
|
|
6955
6955
|
{
|
|
6956
6956
|
"disabled": false,
|
|
6957
6957
|
"document": "在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。支持的印章类型包括：\n\n<ul>\n<li><strong>OFFICIAL</strong>：企业公章，用于代表企业对外的正式文件和重要事务的认证。</li>\n<li><strong>CONTRACT</strong>：合同专用章，专门用于签署各类合同。</li>\n<li><strong>FINANCE</strong>：财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证。</li>\n<li><strong>PERSONNEL</strong>：人事专用章，用于人事管理相关文件，如劳动合同、人事任命等。</li>\n</ul>",
|
|
6958
|
-
"example": "OFFICIAL",
|
|
6958
|
+
"example": "[\"OFFICIAL\"]",
|
|
6959
6959
|
"member": "string",
|
|
6960
6960
|
"name": "SealTypes",
|
|
6961
6961
|
"required": false,
|
|
@@ -6989,7 +6989,7 @@
|
|
|
6989
6989
|
{
|
|
6990
6990
|
"disabled": false,
|
|
6991
6991
|
"document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径",
|
|
6992
|
-
"example": "pages/guide?
|
|
6992
|
+
"example": "pages/guide?where=mini&shortKey=yDwivUAW1",
|
|
6993
6993
|
"member": "string",
|
|
6994
6994
|
"name": "MiniAppPath",
|
|
6995
6995
|
"output_required": false,
|
|
@@ -13475,7 +13475,7 @@
|
|
|
13475
13475
|
},
|
|
13476
13476
|
{
|
|
13477
13477
|
"disabled": false,
|
|
13478
|
-
"document": "文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。\n
|
|
13478
|
+
"document": "文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。\n注：此字段定义为数组，但仅支持单个文件",
|
|
13479
13479
|
"example": "[\"yDt1JUUckp77a2omUyEmko88eg49PTsN\"]",
|
|
13480
13480
|
"member": "string",
|
|
13481
13481
|
"name": "FileIds",
|
|
@@ -13521,7 +13521,7 @@
|
|
|
13521
13521
|
{
|
|
13522
13522
|
"disabled": true,
|
|
13523
13523
|
"document": "合同（流程）的回调地址",
|
|
13524
|
-
"example": "
|
|
13524
|
+
"example": "http://www.qq.com/callback",
|
|
13525
13525
|
"member": "string",
|
|
13526
13526
|
"name": "CallbackUrl",
|
|
13527
13527
|
"required": false,
|
|
@@ -14164,6 +14164,15 @@
|
|
|
14164
14164
|
"name": "IntentionActions",
|
|
14165
14165
|
"required": false,
|
|
14166
14166
|
"type": "list"
|
|
14167
|
+
},
|
|
14168
|
+
{
|
|
14169
|
+
"disabled": false,
|
|
14170
|
+
"document": "视频核身相关配置",
|
|
14171
|
+
"example": "无",
|
|
14172
|
+
"member": "RuleIdConfig",
|
|
14173
|
+
"name": "RuleIdConfig",
|
|
14174
|
+
"required": false,
|
|
14175
|
+
"type": "object"
|
|
14167
14176
|
}
|
|
14168
14177
|
],
|
|
14169
14178
|
"usage": "in"
|
|
@@ -16589,6 +16598,21 @@
|
|
|
16589
16598
|
],
|
|
16590
16599
|
"usage": "both"
|
|
16591
16600
|
},
|
|
16601
|
+
"RuleIdConfig": {
|
|
16602
|
+
"document": "视频核身相关配置",
|
|
16603
|
+
"members": [
|
|
16604
|
+
{
|
|
16605
|
+
"disabled": false,
|
|
16606
|
+
"document": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0：\n0-智能语速（根据播报文案的长度自动调整语音播报速度）\n1-固定1倍速\n2-固定1.2倍速\n3-固定1.5倍速",
|
|
16607
|
+
"example": "0",
|
|
16608
|
+
"member": "uint64",
|
|
16609
|
+
"name": "Speed",
|
|
16610
|
+
"required": false,
|
|
16611
|
+
"type": "int"
|
|
16612
|
+
}
|
|
16613
|
+
],
|
|
16614
|
+
"usage": "in"
|
|
16615
|
+
},
|
|
16592
16616
|
"SealInfo": {
|
|
16593
16617
|
"document": "模板中指定的印章信息",
|
|
16594
16618
|
"members": [
|
|
@@ -1696,7 +1696,7 @@
|
|
|
1696
1696
|
{
|
|
1697
1697
|
"document": "查询已实名员工列表\n1. Filter参数Key设置为\"Status\";\n2. Filter参数Values设置为\"IsVerified\"，表示查询已实名员工；\n3. 设置Limit和Offset参数，从首页开始，每页查询20条数据返回。",
|
|
1698
1698
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeIntegrationEmployees\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"11234********************678901\"\n },\n \"Filters\": [\n {\n \"Key\": \"Status\",\n \"Values\": [\n \"IsVerified\"\n ]\n }\n ],\n \"Limit\": 20,\n \"Offset\": 0\n}",
|
|
1699
|
-
"output": "{\n \"Response\": {\n \"Employees\": [\n {\n \"CreatedOn\": 1658114069,\n \"Department\": {\n \"DepartmentId\": \"dp**********************155f2\",\n \"DepartmentName\": \"测试企业\"\n },\n \"DisplayName\": \"张三\",\n \"Email\": \"\",\n \"Mobile\": \"
|
|
1699
|
+
"output": "{\n \"Response\": {\n \"Employees\": [\n {\n \"CreatedOn\": 1658114069,\n \"Department\": {\n \"DepartmentId\": \"dp**********************155f2\",\n \"DepartmentName\": \"测试企业\"\n },\n \"DisplayName\": \"张三\",\n \"Email\": \"\",\n \"Mobile\": \"133****1233\",\n \"OpenId\": \"\",\n \"QuiteJob\": 0,\n \"ReceiveOpenId\": \"\",\n \"ReceiveUserId\": \"\",\n \"Roles\": [\n {\n \"RoleId\": \"ea4ab3******************a6902\",\n \"RoleName\": \"法人\"\n },\n {\n \"RoleId\": \"9b7d******************cf8e9\",\n \"RoleName\": \"业务员\"\n },\n {\n \"RoleId\": \"4dff1******************10b\",\n \"RoleName\": \"企业员工\"\n }\n ],\n \"UserId\": \"yDRt******************BKpnZs\",\n \"Verified\": true,\n \"VerifiedOn\": 1658114065,\n \"WeworkOpenId\": \"\"\n },\n {\n \"CreatedOn\": 1658114000,\n \"Department\": {\n \"DepartmentId\": \"dp**********************155f2\",\n \"DepartmentName\": \"测试企业\"\n },\n \"DisplayName\": \"李四\",\n \"Email\": \"\",\n \"Mobile\": \"135****1234\",\n \"OpenId\": \"\",\n \"QuiteJob\": 0,\n \"ReceiveOpenId\": \"\",\n \"ReceiveUserId\": \"\",\n \"Roles\": [\n {\n \"RoleId\": \"4fcbf3******************ea6c63\",\n \"RoleName\": \"超级管理员\"\n }\n ],\n \"UserId\": \"yDwJ******************BGQyov\",\n \"Verified\": true,\n \"VerifiedOn\": 1658114066,\n \"WeworkOpenId\": \"\"\n }\n ],\n \"Limit\": 20,\n \"Offset\": 0,\n \"RequestId\": \"s1663******************195\",\n \"TotalCount\": 2\n }\n}",
|
|
1700
1700
|
"title": "查询员工列表（查询已实名员工列表）"
|
|
1701
1701
|
}
|
|
1702
1702
|
],
|
|
@@ -11569,6 +11569,15 @@
|
|
|
11569
11569
|
"name": "IntentionActions",
|
|
11570
11570
|
"required": false,
|
|
11571
11571
|
"type": "list"
|
|
11572
|
+
},
|
|
11573
|
+
{
|
|
11574
|
+
"disabled": false,
|
|
11575
|
+
"document": "视频核身相关配置",
|
|
11576
|
+
"example": "无",
|
|
11577
|
+
"member": "RuleIdConfig",
|
|
11578
|
+
"name": "RuleIdConfig",
|
|
11579
|
+
"required": false,
|
|
11580
|
+
"type": "object"
|
|
11572
11581
|
}
|
|
11573
11582
|
],
|
|
11574
11583
|
"usage": "in"
|
|
@@ -13606,6 +13615,21 @@
|
|
|
13606
13615
|
],
|
|
13607
13616
|
"usage": "out"
|
|
13608
13617
|
},
|
|
13618
|
+
"RuleIdConfig": {
|
|
13619
|
+
"document": "视频核身相关配置",
|
|
13620
|
+
"members": [
|
|
13621
|
+
{
|
|
13622
|
+
"disabled": false,
|
|
13623
|
+
"document": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0：\n0-智能语速（根据播报文案的长度自动调整语音播报速度）\n1-固定1倍速\n2-固定1.2倍速\n3-固定1.5倍速",
|
|
13624
|
+
"example": "0",
|
|
13625
|
+
"member": "uint64",
|
|
13626
|
+
"name": "Speed",
|
|
13627
|
+
"required": false,
|
|
13628
|
+
"type": "int"
|
|
13629
|
+
}
|
|
13630
|
+
],
|
|
13631
|
+
"usage": "in"
|
|
13632
|
+
},
|
|
13609
13633
|
"SignComponentConfig": {
|
|
13610
13634
|
"document": "签署控件的配置信息，用在嵌入式发起的页面配置，包括 \n\n- 签署控件 是否默认展示日期.",
|
|
13611
13635
|
"members": [
|
|
@@ -2257,7 +2257,7 @@
|
|
|
2257
2257
|
"members": [
|
|
2258
2258
|
{
|
|
2259
2259
|
"disabled": false,
|
|
2260
|
-
"document": "
|
|
2260
|
+
"document": "人脸核身识别结果及文本类信息。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2261
2261
|
"example": "无",
|
|
2262
2262
|
"member": "DetectInfoText",
|
|
2263
2263
|
"name": "Text",
|
|
@@ -2345,6 +2345,26 @@
|
|
|
2345
2345
|
"type": "string",
|
|
2346
2346
|
"value_allowed_null": true
|
|
2347
2347
|
},
|
|
2348
|
+
{
|
|
2349
|
+
"disabled": false,
|
|
2350
|
+
"document": "本次请求是否配置开启意愿校验。 \nfalse：未开启意愿校验 \ntrue：已开启意愿校验 \n说明：若请求开启了意愿校验，可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果；若请求没有开启意愿校验，则可在出参Text中获取最终的核验结果。",
|
|
2351
|
+
"example": "false",
|
|
2352
|
+
"member": "bool",
|
|
2353
|
+
"name": "IsVerifyIntention",
|
|
2354
|
+
"output_required": true,
|
|
2355
|
+
"type": "bool",
|
|
2356
|
+
"value_allowed_null": false
|
|
2357
|
+
},
|
|
2358
|
+
{
|
|
2359
|
+
"disabled": false,
|
|
2360
|
+
"document": "本次请求意愿校验使用的具体模式。\n0：问答模式\n1：点头确认模式\n2：朗读模式\n若未使用意愿核身功能，该字段返回值可以不处理。\n注意：此字段可能返回 null，表示取不到有效值",
|
|
2361
|
+
"example": "0",
|
|
2362
|
+
"member": "string",
|
|
2363
|
+
"name": "IntentionVerifyType",
|
|
2364
|
+
"output_required": true,
|
|
2365
|
+
"type": "string",
|
|
2366
|
+
"value_allowed_null": false
|
|
2367
|
+
},
|
|
2348
2368
|
{
|
|
2349
2369
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
2350
2370
|
"member": "string",
|
|
@@ -2465,7 +2485,7 @@
|
|
|
2465
2485
|
"members": [
|
|
2466
2486
|
{
|
|
2467
2487
|
"disabled": false,
|
|
2468
|
-
"document": "
|
|
2488
|
+
"document": "人脸核身识别结果及文本类信息。\n- 基于对敏感信息的保护，验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。\n- 如需获取请在控制台申请返回身份信息，详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
2469
2489
|
"example": "无",
|
|
2470
2490
|
"member": "DetectInfoText",
|
|
2471
2491
|
"name": "Text",
|
|
@@ -2533,6 +2553,26 @@
|
|
|
2533
2553
|
"type": "object",
|
|
2534
2554
|
"value_allowed_null": true
|
|
2535
2555
|
},
|
|
2556
|
+
{
|
|
2557
|
+
"disabled": false,
|
|
2558
|
+
"document": "本次请求是否配置开启意愿校验。 \nfalse：未开启意愿校验 \ntrue：已开启意愿校验 \n说明：若请求开启了意愿校验，可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果；若请求没有开启意愿校验，则可在出参Text中获取最终的核验结果。",
|
|
2559
|
+
"example": "false",
|
|
2560
|
+
"member": "bool",
|
|
2561
|
+
"name": "IsVerifyIntention",
|
|
2562
|
+
"output_required": true,
|
|
2563
|
+
"type": "bool",
|
|
2564
|
+
"value_allowed_null": false
|
|
2565
|
+
},
|
|
2566
|
+
{
|
|
2567
|
+
"disabled": false,
|
|
2568
|
+
"document": "本次请求意愿校验使用的具体模式。 \n0：问答模式 \n1：点头确认模式 \n2：朗读模式 \n若未使用意愿核身功能，该字段返回值可以不处理。 \n注意：此字段可能返回 null，表示取不到有效值",
|
|
2569
|
+
"example": "0",
|
|
2570
|
+
"member": "string",
|
|
2571
|
+
"name": "IntentionVerifyType",
|
|
2572
|
+
"output_required": true,
|
|
2573
|
+
"type": "string",
|
|
2574
|
+
"value_allowed_null": false
|
|
2575
|
+
},
|
|
2536
2576
|
{
|
|
2537
2577
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
2538
2578
|
"member": "string",
|
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
{
|
|
193
193
|
"document": "",
|
|
194
194
|
"input": "POST / HTTP/1.1\nHost: faceid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetDetectInfoEnhanced\n<公共请求参数>\n\n{\n \"InfoType\": \"1\",\n \"BizToken\": \"CE661F1A-0F1E-45BD-BE13-34C05CEA7681\",\n \"RuleId\": \"0\"\n}",
|
|
195
|
-
"output": "{\n \"Response\": {\n \"BestFrame\": {\n \"BestFrame\": \"/9j/4AAQSk...JKD2A//9k=\",\n \"BestFrames\": [\n \"/9j/4AAQSk...002dgP/9k=\",\n \"/9j/4AAQSk...vx+YH/2Q==\",\n \"/9j/4AAQSk...n6fj5Af//Z\",\n \"/9j/4AAQSk...dzlFFagf/Z\"\n ]\n },\n \"EncryptedBody\": \"\",\n \"Encryption\": {\n \"Algorithm\": \"\",\n \"CiphertextBlob\": \"\",\n \"EncryptList\": [],\n \"Iv\": \"\",\n \"TagList\": []\n },\n \"IdCardData\": {\n \"Avatar\": null,\n \"BackWarnInfos\": null,\n \"OcrBack\": null,\n \"OcrFront\": null,\n \"ProcessedBackImage\": null,\n \"ProcessedFrontImage\": null,\n \"WarnInfos\": null\n },\n \"IntentionActionResult\": null,\n \"IntentionQuestionResult\": {\n \"AsrResult\": [],\n \"Audios\": [],\n \"FinalResultCode\": null,\n \"FinalResultDetailCode\": null,\n \"FinalResultMessage\": null,\n \"ResultCode\": [],\n \"ScreenShot\": [],\n \"Video\": null\n },\n \"IntentionVerifyData\": {\n \"AsrResult\": null,\n \"AsrResultSimilarity\": null,\n \"ErrorCode\": null,\n \"ErrorMessage\": null,\n \"IntentionVerifyBestFrame\": null,\n \"IntentionVerifyVideo\": null\n },\n \"RequestId\": \"91173d84-e461-4da4-a270-2b8d48a2e136\",\n \"Text\": {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"ErrCode\": 0,\n \"ErrMsg\": \"成功\",\n \"Extra\": \"\",\n \"IdCard\": \"11204416541220243X\",\n \"IdInfoFrom\": \"其他\",\n \"LiveMsg\": \"成功\",\n \"LiveStatus\": 0,\n \"LivenessDetail\": [\n {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"Errcode\": 0,\n \"Errmsg\": \"成功\",\n \"Idcard\": \"11204416541220243X\",\n \"IsNeedCharge\": true,\n \"Livemsg\": \"成功\",\n \"LivenessMode\": 1,\n \"Livestatus\": 0,\n \"Name\": \"韦小宝\",\n \"ReqTime\": \"1730444265275\",\n \"Seq\": \"1f330eea-f5db-4726-a7b4-38cdf1aefb02\",\n \"Sim\": \"95.51\"\n }\n ],\n \"LivenessInfoTag\": null,\n \"LivenessMode\": 1,\n \"Location\": null,\n \"Mobile\": \"\",\n \"NFCBillingCounts\": 0,\n \"NFCRequestIds\": [],\n \"Name\": \"韦小宝\",\n \"OcrAddress\": null,\n \"OcrAuthority\": null,\n \"OcrBirth\": null,\n \"OcrGender\": null,\n \"OcrIdCard\": \"\",\n \"OcrName\": \"\",\n \"OcrNation\": null,\n \"OcrValidDate\": null,\n \"PassNo\": null,\n \"Sim\": \"95.51\",\n \"UseIDType\": 0,\n \"VisaNum\": null\n },\n \"VideoData\": {\n \"LivenessVideo\": \"AAAAGGZ0eX...VyYWxidW0h\"\n }\n }\n}",
|
|
195
|
+
"output": "{\n \"Response\": {\n \"BestFrame\": {\n \"BestFrame\": \"/9j/4AAQSk...JKD2A//9k=\",\n \"BestFrames\": [\n \"/9j/4AAQSk...002dgP/9k=\",\n \"/9j/4AAQSk...vx+YH/2Q==\",\n \"/9j/4AAQSk...n6fj5Af//Z\",\n \"/9j/4AAQSk...dzlFFagf/Z\"\n ]\n },\n \"EncryptedBody\": \"\",\n \"Encryption\": {\n \"Algorithm\": \"\",\n \"CiphertextBlob\": \"\",\n \"EncryptList\": [],\n \"Iv\": \"\",\n \"TagList\": []\n },\n \"IdCardData\": {\n \"Avatar\": null,\n \"BackWarnInfos\": null,\n \"OcrBack\": null,\n \"OcrFront\": null,\n \"ProcessedBackImage\": null,\n \"ProcessedFrontImage\": null,\n \"WarnInfos\": null\n },\n \"IntentionActionResult\": null,\n \"IntentionQuestionResult\": {\n \"AsrResult\": [],\n \"Audios\": [],\n \"FinalResultCode\": null,\n \"FinalResultDetailCode\": null,\n \"FinalResultMessage\": null,\n \"ResultCode\": [],\n \"ScreenShot\": [],\n \"Video\": null\n },\n \"IntentionVerifyData\": {\n \"AsrResult\": null,\n \"AsrResultSimilarity\": null,\n \"ErrorCode\": null,\n \"ErrorMessage\": null,\n \"IntentionVerifyBestFrame\": null,\n \"IntentionVerifyVideo\": null\n },\n \"IsVerifyIntention\": false,\n \"IntentionVerifyType\": \"\",\n \"RequestId\": \"91173d84-e461-4da4-a270-2b8d48a2e136\",\n \"Text\": {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"ErrCode\": 0,\n \"ErrMsg\": \"成功\",\n \"Extra\": \"\",\n \"IdCard\": \"11204416541220243X\",\n \"IdInfoFrom\": \"其他\",\n \"LiveMsg\": \"成功\",\n \"LiveStatus\": 0,\n \"LivenessDetail\": [\n {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"Errcode\": 0,\n \"Errmsg\": \"成功\",\n \"Idcard\": \"11204416541220243X\",\n \"IsNeedCharge\": true,\n \"Livemsg\": \"成功\",\n \"LivenessMode\": 1,\n \"Livestatus\": 0,\n \"Name\": \"韦小宝\",\n \"ReqTime\": \"1730444265275\",\n \"Seq\": \"1f330eea-f5db-4726-a7b4-38cdf1aefb02\",\n \"Sim\": \"95.51\"\n }\n ],\n \"LivenessInfoTag\": null,\n \"LivenessMode\": 1,\n \"Location\": null,\n \"Mobile\": \"\",\n \"NFCBillingCounts\": 0,\n \"NFCRequestIds\": [],\n \"Name\": \"韦小宝\",\n \"OcrAddress\": null,\n \"OcrAuthority\": null,\n \"OcrBirth\": null,\n \"OcrGender\": null,\n \"OcrIdCard\": \"\",\n \"OcrName\": \"\",\n \"OcrNation\": null,\n \"OcrValidDate\": null,\n \"PassNo\": null,\n \"Sim\": \"95.51\",\n \"UseIDType\": 0,\n \"VisaNum\": null\n },\n \"VideoData\": {\n \"LivenessVideo\": \"AAAAGGZ0eX...VyYWxidW0h\"\n }\n }\n}",
|
|
196
196
|
"title": "获取结果信息成功示例"
|
|
197
197
|
},
|
|
198
198
|
{
|
|
@@ -206,7 +206,7 @@
|
|
|
206
206
|
{
|
|
207
207
|
"document": "成功获取E证通结果信息。",
|
|
208
208
|
"input": "POST / HTTP/1.1\nHost: faceid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetEidResult\n<公共请求参数>\n\n{\n \"InfoType\": \"1\",\n \"EidToken\": \"CE661F1A-0F1E-45BD-BE133-34C05CEA76812\"\n}",
|
|
209
|
-
"output": "{\n \"Response\": {\n \"BestFrame\": {\n \"BestFrame\": \"/9j/4AAQSk...UVoYn/2Q==\",\n \"BestFrames\": [\n \"/9j/4AAQSk...AT/U//2Q==\"\n ]\n },\n \"EidInfo\": {\n \"DesKey\": \"\",\n \"EidCode\": \"OMKhJ5hkbPnA5PKGrzD1oKZ/e8W9w2g1yAOUIry7G/4xMDAw\",\n \"EidSign\": \"MEQCIDt0Xa...YygK4Fhw==\",\n \"UserInfo\": \"\"\n },\n \"IdCardData\": {\n \"Avatar\": \"\",\n \"BackWarnInfos\": null,\n \"OcrBack\": \"\",\n \"OcrFront\": \"\",\n \"ProcessedBackImage\": \"\",\n \"ProcessedFrontImage\": \"\",\n \"WarnInfos\": null\n },\n \"IntentionActionResult\": null,\n \"IntentionQuestionResult\": {\n \"AsrResult\": null,\n \"Audios\": null,\n \"FinalResultCode\": \"\",\n \"FinalResultDetailCode\": null,\n \"FinalResultMessage\": null,\n \"ResultCode\": null,\n \"ScreenShot\": null,\n \"Video\": \"\"\n },\n \"IntentionVerifyData\": {\n \"AsrResult\": \"\",\n \"AsrResultSimilarity\": \"\",\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"IntentionVerifyBestFrame\": \"\",\n \"IntentionVerifyVideo\": \"\"\n },\n \"RequestId\": \"29a30ec8-0c15-4566-a5ab-99f88a3f0821\",\n \"Text\": {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"ErrCode\": 0,\n \"ErrMsg\": \"成功\",\n \"Extra\": \"\",\n \"IdCard\": \"\",\n \"IdInfoFrom\": \"其他\",\n \"LiveMsg\": \"成功\",\n \"LiveStatus\": 0,\n \"LivenessInfoTag\": [\n \"01\"\n ],\n \"LivenessDetail\": [\n {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"Errcode\": 0,\n \"Errmsg\": \"成功\",\n \"Idcard\": \"\",\n \"IsNeedCharge\": true,\n \"Livemsg\": \"成功\",\n \"LivenessMode\": 4,\n \"Livestatus\": 0,\n \"Name\": \"\",\n \"ReqTime\": \"1730451371368\",\n \"Seq\": \"092ff8ca-4d1c-4c2122-b513-ec8ced564c9a\",\n \"Sim\": \"97.31\"\n }\n ],\n \"LivenessMode\": 4,\n \"Location\": \"\",\n \"Mobile\": \"\",\n \"NFCBillingCounts\": 0,\n \"NFCRequestIds\": null,\n \"Name\": \"\",\n \"OcrAddress\": \"\",\n \"OcrAuthority\": \"\",\n \"OcrBirth\": \"\",\n \"OcrGender\": \"\",\n \"OcrIdCard\": \"\",\n \"OcrName\": \"\",\n \"OcrNation\": \"\",\n \"OcrValidDate\": \"\",\n \"PassNo\": \"\",\n \"Sim\": \"97.31\",\n \"UseIDType\": 0,\n \"VisaNum\": \"\"\n }\n }\n}",
|
|
209
|
+
"output": "{\n \"Response\": {\n \"BestFrame\": {\n \"BestFrame\": \"/9j/4AAQSk...UVoYn/2Q==\",\n \"BestFrames\": [\n \"/9j/4AAQSk...AT/U//2Q==\"\n ]\n },\n \"EidInfo\": {\n \"DesKey\": \"\",\n \"EidCode\": \"OMKhJ5hkbPnA5PKGrzD1oKZ/e8W9w2g1yAOUIry7G/4xMDAw\",\n \"EidSign\": \"MEQCIDt0Xa...YygK4Fhw==\",\n \"UserInfo\": \"\"\n },\n \"IdCardData\": {\n \"Avatar\": \"\",\n \"BackWarnInfos\": null,\n \"OcrBack\": \"\",\n \"OcrFront\": \"\",\n \"ProcessedBackImage\": \"\",\n \"ProcessedFrontImage\": \"\",\n \"WarnInfos\": null\n },\n \"IsVerifyIntention\": false,\n \"IntentionVerifyType\": \"\",\n \"IntentionActionResult\": null,\n \"IntentionQuestionResult\": {\n \"AsrResult\": null,\n \"Audios\": null,\n \"FinalResultCode\": \"\",\n \"FinalResultDetailCode\": null,\n \"FinalResultMessage\": null,\n \"ResultCode\": null,\n \"ScreenShot\": null,\n \"Video\": \"\"\n },\n \"IntentionVerifyData\": {\n \"AsrResult\": \"\",\n \"AsrResultSimilarity\": \"\",\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"IntentionVerifyBestFrame\": \"\",\n \"IntentionVerifyVideo\": \"\"\n },\n \"RequestId\": \"29a30ec8-0c15-4566-a5ab-99f88a3f0821\",\n \"Text\": {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"ErrCode\": 0,\n \"ErrMsg\": \"成功\",\n \"Extra\": \"\",\n \"IdCard\": \"\",\n \"IdInfoFrom\": \"其他\",\n \"LiveMsg\": \"成功\",\n \"LiveStatus\": 0,\n \"LivenessInfoTag\": [\n \"01\"\n ],\n \"LivenessDetail\": [\n {\n \"CompareLibType\": \"权威库\",\n \"Comparemsg\": \"成功\",\n \"Comparestatus\": 0,\n \"Errcode\": 0,\n \"Errmsg\": \"成功\",\n \"Idcard\": \"\",\n \"IsNeedCharge\": true,\n \"Livemsg\": \"成功\",\n \"LivenessMode\": 4,\n \"Livestatus\": 0,\n \"Name\": \"\",\n \"ReqTime\": \"1730451371368\",\n \"Seq\": \"092ff8ca-4d1c-4c2122-b513-ec8ced564c9a\",\n \"Sim\": \"97.31\"\n }\n ],\n \"LivenessMode\": 4,\n \"Location\": \"\",\n \"Mobile\": \"\",\n \"NFCBillingCounts\": 0,\n \"NFCRequestIds\": null,\n \"Name\": \"\",\n \"OcrAddress\": \"\",\n \"OcrAuthority\": \"\",\n \"OcrBirth\": \"\",\n \"OcrGender\": \"\",\n \"OcrIdCard\": \"\",\n \"OcrName\": \"\",\n \"OcrNation\": \"\",\n \"OcrValidDate\": \"\",\n \"PassNo\": \"\",\n \"Sim\": \"97.31\",\n \"UseIDType\": 0,\n \"VisaNum\": \"\"\n }\n }\n}",
|
|
210
210
|
"title": "获取E证通结果信息成功示例"
|
|
211
211
|
},
|
|
212
212
|
{
|
|
@@ -759,7 +759,7 @@
|
|
|
759
759
|
},
|
|
760
760
|
"metadata": {
|
|
761
761
|
"apiVersion": "2020-03-24",
|
|
762
|
-
"api_brief": "介绍如何使用API对
|
|
762
|
+
"api_brief": "介绍如何使用API对 Lighthouse 资源和服务进行相关操作，如启动实例、关闭实例、重启实例、查询实例列表等。",
|
|
763
763
|
"serviceNameCN": "轻量应用服务器",
|
|
764
764
|
"serviceShortName": "lighthouse"
|
|
765
765
|
},
|
|
@@ -890,7 +890,7 @@
|
|
|
890
890
|
{
|
|
891
891
|
"disabled": false,
|
|
892
892
|
"document": "Agent可转交的子AgentId列表",
|
|
893
|
-
"example": "[agent-id1, agent-id2]",
|
|
893
|
+
"example": "[\"agent-id1\", \"agent-id2\"]",
|
|
894
894
|
"member": "string",
|
|
895
895
|
"name": "Handoffs",
|
|
896
896
|
"output_required": false,
|
|
@@ -18170,7 +18170,7 @@
|
|
|
18170
18170
|
{
|
|
18171
18171
|
"disabled": false,
|
|
18172
18172
|
"document": "工作流画布Json",
|
|
18173
|
-
"example": "
|
|
18173
|
+
"example": "{\"WorkflowID\":\"xxx\",\"WorkflowName\":\"qwe\",\"WorkflowDesc\":\"135\",\"Nodes\":[]}",
|
|
18174
18174
|
"member": "string",
|
|
18175
18175
|
"name": "DialogJson",
|
|
18176
18176
|
"output_required": false,
|
|
@@ -18203,7 +18203,7 @@
|
|
|
18203
18203
|
{
|
|
18204
18204
|
"disabled": false,
|
|
18205
18205
|
"document": "API参数配置",
|
|
18206
|
-
"example": "
|
|
18206
|
+
"example": "无",
|
|
18207
18207
|
"member": "CustomVariable",
|
|
18208
18208
|
"name": "CustomVariables",
|
|
18209
18209
|
"output_required": false,
|