tccli 3.0.1189.1__py2.py3-none-any.whl → 3.0.1191.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/command.py +7 -1
- tccli/configure.py +11 -3
- tccli/loaders.py +43 -8
- tccli/oauth.py +115 -0
- tccli/plugin.py +30 -0
- tccli/plugins/__init__.py +0 -0
- tccli/plugins/auth/__init__.py +59 -0
- tccli/plugins/auth/browser_flow.py +88 -0
- tccli/plugins/auth/login.py +130 -0
- tccli/plugins/auth/logout.py +21 -0
- tccli/plugins/auth/texts.py +30 -0
- tccli/plugins/test/__init__.py +87 -0
- tccli/plugins/test/add.py +31 -0
- tccli/services/__init__.py +2 -1
- tccli/services/apm/v20210622/api.json +19 -0
- tccli/services/cam/cam_client.py +138 -32
- tccli/services/cam/v20190116/api.json +203 -0
- tccli/services/cam/v20190116/examples.json +16 -0
- tccli/services/cdb/v20170320/api.json +4 -4
- tccli/services/cfg/v20210820/api.json +1 -1
- tccli/services/cfw/v20190904/api.json +82 -2
- tccli/services/dasb/dasb_client.py +53 -0
- tccli/services/dasb/v20191018/api.json +168 -0
- tccli/services/dasb/v20191018/examples.json +8 -0
- tccli/services/dlc/v20210125/api.json +287 -37
- tccli/services/dlc/v20210125/examples.json +18 -18
- tccli/services/dsgc/v20190723/api.json +13 -3
- tccli/services/emr/v20190103/api.json +1 -1
- tccli/services/ess/v20201111/api.json +56 -23
- tccli/services/ess/v20201111/examples.json +7 -1
- tccli/services/essbasic/v20210526/api.json +28 -1
- tccli/services/essbasic/v20210526/examples.json +6 -0
- tccli/services/iotexplorer/v20190423/api.json +2 -2
- tccli/services/iss/iss_client.py +118 -65
- tccli/services/iss/v20230517/api.json +78 -0
- tccli/services/iss/v20230517/examples.json +8 -0
- tccli/services/mps/v20190612/api.json +257 -8
- tccli/services/ocr/v20181119/api.json +10 -0
- tccli/services/region/v20220627/api.json +11 -11
- tccli/services/region/v20220627/examples.json +1 -1
- tccli/services/sms/v20210111/api.json +9 -9
- tccli/services/ssl/v20191205/api.json +3 -3
- tccli/services/ssl/v20191205/examples.json +2 -2
- tccli/services/tat/v20201028/api.json +10 -0
- tccli/services/tcb/v20180608/api.json +2 -2
- tccli/services/tdmq/v20200217/api.json +2 -2
- tccli/services/tdmq/v20200217/examples.json +2 -2
- tccli/services/tke/tke_client.py +364 -46
- tccli/services/tke/v20180525/api.json +9 -0
- tccli/services/tke/v20220501/api.json +525 -0
- tccli/services/tke/v20220501/examples.json +54 -0
- tccli/services/tmt/v20180321/api.json +2 -2
- tccli/services/vdb/v20230616/api.json +29 -1
- tccli/services/vod/v20180717/api.json +30 -9
- tccli/services/vod/v20180717/examples.json +1 -1
- tccli/services/vod/v20240718/api.json +121 -0
- tccli/services/vod/v20240718/examples.json +31 -0
- tccli/services/vod/vod_client.py +58 -0
- tccli/services/vpc/v20170312/api.json +9 -0
- tccli/services/wedata/v20210820/api.json +1 -1
- {tccli-3.0.1189.1.dist-info → tccli-3.0.1191.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1189.1.dist-info → tccli-3.0.1191.1.dist-info}/RECORD +66 -54
- {tccli-3.0.1189.1.dist-info → tccli-3.0.1191.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1189.1.dist-info → tccli-3.0.1191.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1189.1.dist-info → tccli-3.0.1191.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"AddDMSPartitions": [
|
|
4
4
|
{
|
|
5
5
|
"document": "",
|
|
6
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddDMSPartitions\n<公共请求参数>\n\n{\n \"Partitions\": [\n {\n \"Sds\": {\n \"OutputFormat\": \"
|
|
7
|
-
"output": "{\n \"Response\": {\n \"Total\": 0,\n \"
|
|
6
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddDMSPartitions\n<公共请求参数>\n\n{\n \"Partitions\": [\n {\n \"Sds\": {\n \"OutputFormat\": \"abc\",\n \"SortCols\": {\n \"Col\": \"abc\",\n \"Order\": 1\n },\n \"InputFormat\": \"abc\",\n \"SerdeLib\": \"abc\",\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"IsPartition\": false,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Position\": 1,\n \"Type\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"Compressed\": false,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Location\": \"abc\",\n \"NumBuckets\": 0,\n \"SerdeParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SerdeName\": \"abc\",\n \"StoredAsSubDirectories\": false,\n \"BucketCols\": [\n \"aa\",\n \"bb\"\n ]\n },\n \"Name\": \"abc\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 1,\n \"RecordCount\": 1,\n \"TableName\": \"abc\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Values\": [\n \"1\",\n \"2\"\n ],\n \"DatabaseName\": \"abc\",\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SchemaName\": \"abc\",\n \"StorageSize\": 1,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\"\n }\n ]\n}",
|
|
7
|
+
"output": "{\n \"Response\": {\n \"Total\": 0,\n \"Partitions\": [\n {\n \"DatabaseName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"TableName\": \"abc\",\n \"DataVersion\": 0,\n \"Name\": \"abc\",\n \"Values\": [\n \"abc\"\n ],\n \"StorageSize\": 0,\n \"RecordCount\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Sds\": {\n \"Location\": \"abc\",\n \"InputFormat\": \"abc\",\n \"OutputFormat\": \"abc\",\n \"NumBuckets\": 0,\n \"Compressed\": true,\n \"StoredAsSubDirectories\": true,\n \"SerdeLib\": \"abc\",\n \"SerdeName\": \"abc\",\n \"BucketCols\": [\n \"abc\"\n ],\n \"SerdeParams\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"SortCols\": {\n \"Col\": \"abc\",\n \"Order\": 0\n },\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"Description\": \"abc\",\n \"Type\": \"abc\",\n \"Position\": 0,\n \"IsPartition\": true,\n \"BizParams\": [],\n \"Params\": []\n }\n ],\n \"SortColumns\": [\n {\n \"Col\": \"abc\",\n \"Order\": 0\n }\n ]\n }\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
8
8
|
"title": "DMS元数据新增分区"
|
|
9
9
|
}
|
|
10
10
|
],
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"AlterDMSPartition": [
|
|
36
36
|
{
|
|
37
37
|
"document": "修改表分区",
|
|
38
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AlterDMSPartition\n<公共请求参数>\n\n{\n \"CurrentValues\": \"
|
|
38
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AlterDMSPartition\n<公共请求参数>\n\n{\n \"CurrentValues\": \"abc\",\n \"Partition\": {\n \"Sds\": {\n \"OutputFormat\": \"abc\",\n \"SortCols\": {\n \"Col\": \"abc\",\n \"Order\": 0\n },\n \"InputFormat\": \"abc\",\n \"SerdeLib\": \"abc\",\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"IsPartition\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Position\": 0,\n \"Type\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"Compressed\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Location\": \"abc\",\n \"NumBuckets\": 0,\n \"SerdeParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SerdeName\": \"abc\",\n \"StoredAsSubDirectories\": true,\n \"BucketCols\": [\n \"abc\"\n ]\n },\n \"Name\": \"abc\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 0,\n \"RecordCount\": 0,\n \"TableName\": \"abc\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Values\": [\n \"abc\"\n ],\n \"DatabaseName\": \"abc\",\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SchemaName\": \"abc\",\n \"StorageSize\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\"\n },\n \"CurrentTableName\": \"abc\",\n \"CurrentDbName\": \"abc\"\n}",
|
|
39
39
|
"output": "{\n \"Response\": {\n \"RequestId\": \"xxx-xxx-xxx\"\n }\n}",
|
|
40
40
|
"title": "修改表分区"
|
|
41
41
|
}
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"AlterDMSTable": [
|
|
44
44
|
{
|
|
45
45
|
"document": "",
|
|
46
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AlterDMSTable\n<公共请求参数>\n\n{\n \"PartitionKeys\": [\n {\n \"Name\": \"
|
|
46
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AlterDMSTable\n<公共请求参数>\n\n{\n \"PartitionKeys\": [\n {\n \"Name\": \"abc\",\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"IsPartition\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Position\": 0,\n \"Type\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"RecordCount\": 0,\n \"CurrentName\": \"abc\",\n \"Sds\": {\n \"OutputFormat\": \"abc\",\n \"SortCols\": {\n \"Col\": \"col1\",\n \"Order\": 0\n },\n \"InputFormat\": \"abc\",\n \"SerdeLib\": \"abc\",\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"IsPartition\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Position\": 0,\n \"Type\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"Compressed\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Location\": \"cosn://abc\",\n \"NumBuckets\": 0,\n \"SerdeParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SerdeName\": \"abc\",\n \"StoredAsSubDirectories\": true,\n \"BucketCols\": [\n \"abc\"\n ]\n },\n \"StructUpdateTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataUpdateTime\": \"2020-09-22T00:00:00+00:00\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"StorageSize\": 0,\n \"CurrentDbName\": \"db\",\n \"ViewExpandedText\": \"abc\",\n \"Asset\": {\n \"Description\": \"abc\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 0,\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"OwnerAccount\": \"abc\",\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"Catalog\": \"abc\",\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"PermValues\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Owner\": \"abc\",\n \"DatasourceId\": 0,\n \"Guid\": \"abc\",\n \"Id\": 0,\n \"Name\": \"abc\"\n },\n \"LifeTime\": 0,\n \"ViewOriginalText\": \"abc\",\n \"Type\": \"abc\",\n \"DbName\": \"abc\",\n \"Columns\": [\n {\n \"Name\": \"abc\",\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"IsPartition\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Position\": 0,\n \"Type\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"Partitions\": [\n {\n \"Sds\": {\n \"OutputFormat\": \"abc\",\n \"SortCols\": {\n \"Col\": \"col1\",\n \"Order\": 0\n },\n \"InputFormat\": \"abc\",\n \"SerdeLib\": \"abc\",\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"BizParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"IsPartition\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Position\": 0,\n \"Type\": \"abc\",\n \"Description\": \"abc\"\n }\n ],\n \"Compressed\": true,\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"Location\": \"abc\",\n \"NumBuckets\": 0,\n \"SerdeParams\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SerdeName\": \"abc\",\n \"StoredAsSubDirectories\": true,\n \"BucketCols\": [\n \"abc\"\n ]\n },\n \"Name\": \"abc\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"DataVersion\": 0,\n \"RecordCount\": 0,\n \"TableName\": \"abc\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Values\": [\n \"abc\"\n ],\n \"DatabaseName\": \"abc\",\n \"Params\": [\n {\n \"Value\": \"abc\",\n \"Key\": \"abc\"\n }\n ],\n \"SchemaName\": \"abc\",\n \"StorageSize\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\"\n }\n ]\n}",
|
|
47
47
|
"output": "{\n \"Response\": {\n \"RequestId\": \"xxx-xxx-xxx\"\n }\n}",
|
|
48
48
|
"title": "修改表"
|
|
49
49
|
}
|
|
@@ -235,8 +235,8 @@
|
|
|
235
235
|
"CreateResultDownload": [
|
|
236
236
|
{
|
|
237
237
|
"document": "",
|
|
238
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateResultDownload\n<公共请求参数>\n\n{\n \"Force\": true,\n \"TaskId\": \"
|
|
239
|
-
"output": "{\n \"Response\": {\n \"DownloadId\": \"
|
|
238
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateResultDownload\n<公共请求参数>\n\n{\n \"Force\": true,\n \"TaskId\": \"abc\",\n \"Format\": \"abc\"\n}",
|
|
239
|
+
"output": "{\n \"Response\": {\n \"DownloadId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
|
240
240
|
"title": "示例1"
|
|
241
241
|
}
|
|
242
242
|
],
|
|
@@ -339,8 +339,8 @@
|
|
|
339
339
|
"DeleteDataEngine": [
|
|
340
340
|
{
|
|
341
341
|
"document": "",
|
|
342
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteDataEngine\n<公共请求参数>\n\n{\n \"DataEngineNames\": [\n \"
|
|
343
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
342
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteDataEngine\n<公共请求参数>\n\n{\n \"DataEngineNames\": [\n \"public-engine\"\n ]\n}",
|
|
343
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"58abbd19-0394-4f82-84fc-a35c3e2f7c1a\"\n }\n}",
|
|
344
344
|
"title": "test"
|
|
345
345
|
}
|
|
346
346
|
],
|
|
@@ -441,8 +441,8 @@
|
|
|
441
441
|
"DescribeDMSPartitions": [
|
|
442
442
|
{
|
|
443
443
|
"document": "查询表分区",
|
|
444
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDMSPartitions\n<公共请求参数>\n\n{\n \"Name\": \"
|
|
445
|
-
"output": "{\n \"Response\": {\n \"
|
|
444
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDMSPartitions\n<公共请求参数>\n\n{\n \"Name\": \"abc\",\n \"TableName\": \"abc\",\n \"PartValues\": [\n \"abc\"\n ],\n \"Values\": [\n \"abc\"\n ],\n \"DatabaseName\": \"abc\",\n \"PartitionNames\": [\n \"abc\"\n ],\n \"SchemaName\": \"abc\"\n}",
|
|
445
|
+
"output": "{\n \"Response\": {\n \"Partitions\": [\n {\n \"DatabaseName\": \"abc\",\n \"SchemaName\": \"abc\",\n \"TableName\": \"abc\",\n \"DataVersion\": 0,\n \"Name\": \"abc\",\n \"Values\": [\n \"abc\"\n ],\n \"StorageSize\": 0,\n \"RecordCount\": 0,\n \"CreateTime\": \"2020-09-22T00:00:00+00:00\",\n \"ModifiedTime\": \"2020-09-22T00:00:00+00:00\",\n \"LastAccessTime\": \"2020-09-22T00:00:00+00:00\",\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Sds\": {\n \"Location\": \"abc\",\n \"InputFormat\": \"abc\",\n \"OutputFormat\": \"abc\",\n \"NumBuckets\": 0,\n \"Compressed\": true,\n \"StoredAsSubDirectories\": true,\n \"SerdeLib\": \"abc\",\n \"SerdeName\": \"abc\",\n \"BucketCols\": [\n \"abc\"\n ],\n \"SerdeParams\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"Params\": [\n {\n \"Key\": \"abc\",\n \"Value\": \"abc\"\n }\n ],\n \"SortCols\": {\n \"Col\": \"abc\",\n \"Order\": 0\n },\n \"Cols\": [\n {\n \"Name\": \"abc\",\n \"Description\": \"abc\",\n \"Type\": \"abc\",\n \"Position\": 0,\n \"IsPartition\": true,\n \"BizParams\": [],\n \"Params\": []\n }\n ],\n \"SortColumns\": [\n {\n \"Col\": \"abc\",\n \"Order\": 0\n }\n ]\n }\n }\n ],\n \"Total\": 0,\n \"RequestId\": \"abc\"\n }\n}",
|
|
446
446
|
"title": "查询表分区"
|
|
447
447
|
}
|
|
448
448
|
],
|
|
@@ -465,16 +465,16 @@
|
|
|
465
465
|
"DescribeDataEngine": [
|
|
466
466
|
{
|
|
467
467
|
"document": "",
|
|
468
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDataEngine\n<公共请求参数>\n\n{\n \"DataEngineName\": \"
|
|
469
|
-
"output": "{\n \"Response\": {\n \"DataEngine\": {\n \"
|
|
468
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDataEngine\n<公共请求参数>\n\n{\n \"DataEngineName\": \"public-engine\"\n}",
|
|
469
|
+
"output": "{\n \"Response\": {\n \"DataEngine\": {\n \"DataEngineName\": \"abc\",\n \"EngineType\": \"abc\",\n \"ClusterType\": \"abc\",\n \"QuotaId\": \"abc\",\n \"State\": 0,\n \"CreateTime\": 0,\n \"UpdateTime\": 0,\n \"Size\": 0,\n \"Mode\": 0,\n \"MinClusters\": 0,\n \"MaxClusters\": 0,\n \"AutoResume\": true,\n \"SpendAfter\": 0,\n \"CidrBlock\": \"abc\",\n \"DefaultDataEngine\": true,\n \"Message\": \"abc\",\n \"DataEngineId\": \"abc\",\n \"SubAccountUin\": \"abc\",\n \"ExpireTime\": \"abc\",\n \"IsolatedTime\": \"abc\",\n \"ReversalTime\": \"abc\",\n \"UserAlias\": \"abc\",\n \"TagList\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"Permissions\": [\n \"abc\"\n ],\n \"AutoSuspend\": true,\n \"CrontabResumeSuspend\": 0,\n \"CrontabResumeSuspendStrategy\": {\n \"ResumeTime\": \"abc\",\n \"SuspendTime\": \"abc\",\n \"SuspendStrategy\": 0\n },\n \"EngineExecType\": \"abc\",\n \"RenewFlag\": 0,\n \"AutoSuspendTime\": 0,\n \"NetworkConnectionSet\": [\n {\n \"Id\": 0,\n \"AssociateId\": \"abc\",\n \"HouseId\": \"abc\",\n \"DatasourceConnectionId\": \"abc\",\n \"State\": 0,\n \"CreateTime\": 0,\n \"UpdateTime\": 0,\n \"Appid\": 0,\n \"HouseName\": \"abc\",\n \"DatasourceConnectionName\": \"abc\",\n \"NetworkConnectionType\": 0,\n \"Uin\": \"abc\",\n \"SubAccountUin\": \"abc\",\n \"NetworkConnectionDesc\": \"abc\",\n \"DatasourceConnectionVpcId\": \"abc\",\n \"DatasourceConnectionSubnetId\": \"abc\",\n \"DatasourceConnectionCidrBlock\": \"abc\",\n \"DatasourceConnectionSubnetCidrBlock\": \"abc\"\n }\n ],\n \"UiURL\": \"abc\",\n \"ResourceType\": \"abc\",\n \"ImageVersionId\": \"abc\",\n \"ChildImageVersionId\": \"abc\",\n \"ImageVersionName\": \"abc\",\n \"StartStandbyCluster\": true,\n \"ElasticSwitch\": true,\n \"ElasticLimit\": 0,\n \"DefaultHouse\": true,\n \"MaxConcurrency\": 0,\n \"TolerableQueueTime\": 0,\n \"UserAppId\": 0,\n \"UserUin\": \"abc\",\n \"SessionResourceTemplate\": {\n \"DriverSize\": \"abc\",\n \"ExecutorSize\": \"abc\",\n \"ExecutorNums\": 1,\n \"ExecutorMaxNumbers\": 1\n },\n \"AutoAuthorization\": true,\n \"EngineGeneration\": \"abc\",\n \"EngineTypeDetail\": \"abc\",\n \"EngineNetworkId\": \"abc\",\n \"EngineResourceGroupCount\": 0,\n \"EngineResourceUsedCU\": 0,\n \"AccessInfos\": [\n {\n \"AccessType\": \"abc\",\n \"AccessConnectionInfos\": [\n \"abc\"\n ]\n }\n ],\n \"EngineNetworkName\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}",
|
|
470
470
|
"title": "test"
|
|
471
471
|
}
|
|
472
472
|
],
|
|
473
473
|
"DescribeDataEngineEvents": [
|
|
474
474
|
{
|
|
475
475
|
"document": "",
|
|
476
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDataEngineEvents\n<公共请求参数>\n\n{\n \"Limit\": 0,\n \"DataEngineName\": \"
|
|
477
|
-
"output": "{\n \"Response\": {\n \"Events\": [\n {\n \"Time\": \"
|
|
476
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDataEngineEvents\n<公共请求参数>\n\n{\n \"Limit\": 0,\n \"DataEngineName\": \"DataEngine-ftvxxx\",\n \"Offset\": 0\n}",
|
|
477
|
+
"output": "{\n \"Response\": {\n \"Events\": [\n {\n \"ClusterInfo\": [\n \"缩容前：集群个数1个，集群规模16CU，缩容后:集群个数0个，集群规模16CU\"\n ],\n \"EventsAction\": [\n \"集群缩容完成\"\n ],\n \"Time\": [\n \"2024-07-22 19:58:28\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"引擎已挂起，原因：自动挂起\"\n ],\n \"EventsAction\": [\n \"引擎挂起\"\n ],\n \"Time\": [\n \"2024-07-22 19:58:08\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"扩容前：集群个数0个，集群规模16CU，扩容后:集群个数1个，集群规模16CU\"\n ],\n \"EventsAction\": [\n \"集群扩容完成\"\n ],\n \"Time\": [\n \"2024-07-22 19:55:09\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"扩容前：集群个数0个，集群规模16CU，扩容后:集群个数1个，集群规模16CU\"\n ],\n \"EventsAction\": [\n \"集群开始扩容\"\n ],\n \"Time\": [\n \"2024-07-22 19:52:39\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"引擎已恢复，原因：自动恢复\"\n ],\n \"EventsAction\": [\n \"集群恢复\"\n ],\n \"Time\": [\n \"2024-07-22 19:52:06\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"缩容前：集群个数1个，集群规模16CU，缩容后:集群个数0个，集群规模16CU\"\n ],\n \"EventsAction\": [\n \"集群缩容完成\"\n ],\n \"Time\": [\n \"2024-07-14 21:58:13\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"引擎已挂起，原因：自动挂起\"\n ],\n \"EventsAction\": [\n \"引擎挂起\"\n ],\n \"Time\": [\n \"2024-07-14 21:57:55\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"扩容前：集群个数0个，集群规模16CU，扩容后:集群个数1个，集群规模16CU\"\n ],\n \"EventsAction\": [\n \"集群扩容完成\"\n ],\n \"Time\": [\n \"2024-07-14 21:52:25\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"扩容前：集群个数0个，集群规模16CU，扩容后:集群个数1个，集群规模16CU\"\n ],\n \"EventsAction\": [\n \"集群开始扩容\"\n ],\n \"Time\": [\n \"2024-07-14 21:49:56\"\n ]\n },\n {\n \"ClusterInfo\": [\n \"引擎已恢复，原因：自动恢复\"\n ],\n \"EventsAction\": [\n \"集群恢复\"\n ],\n \"Time\": [\n \"2024-07-14 21:49:23\"\n ]\n }\n ],\n \"Page\": 1,\n \"RequestId\": \"67ce07dc-8a40-4c1f-aee6-35c7b0f7b04f\",\n \"Size\": 10,\n \"TotalCount\": 198,\n \"TotalPages\": 20\n }\n}",
|
|
478
478
|
"title": "test"
|
|
479
479
|
}
|
|
480
480
|
],
|
|
@@ -546,7 +546,7 @@
|
|
|
546
546
|
{
|
|
547
547
|
"document": "",
|
|
548
548
|
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLakeFsDirSummary\n<公共请求参数>\n\n{}",
|
|
549
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
549
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"123-456-789\"\n }\n}",
|
|
550
550
|
"title": "示例一"
|
|
551
551
|
}
|
|
552
552
|
],
|
|
@@ -625,8 +625,8 @@
|
|
|
625
625
|
"DescribeResultDownload": [
|
|
626
626
|
{
|
|
627
627
|
"document": "",
|
|
628
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResultDownload\n<公共请求参数>\n\n{\n \"DownloadId\": \"
|
|
629
|
-
"output": "{\n \"Response\": {\n \"Status\": \"
|
|
628
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResultDownload\n<公共请求参数>\n\n{\n \"DownloadId\": \"abc\"\n}",
|
|
629
|
+
"output": "{\n \"Response\": {\n \"Status\": \"abc\",\n \"Token\": \"abc\",\n \"SecretKey\": \"abc\",\n \"Reason\": \"abc\",\n \"SecretId\": \"abc\",\n \"RequestId\": \"abc\",\n \"Path\": \"abc\"\n }\n}",
|
|
630
630
|
"title": "示例1"
|
|
631
631
|
}
|
|
632
632
|
],
|
|
@@ -872,7 +872,7 @@
|
|
|
872
872
|
{
|
|
873
873
|
"document": "",
|
|
874
874
|
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DropDMSDatabase\n<公共请求参数>\n\n{\n \"Name\": \"Name1\",\n \"DeleteData\": false,\n \"Cascade\": false\n}",
|
|
875
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
875
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1234567890\"\n }\n}",
|
|
876
876
|
"title": "DMS元数据删除库"
|
|
877
877
|
}
|
|
878
878
|
],
|
|
@@ -4927,7 +4927,7 @@
|
|
|
4927
4927
|
"example": "xx-db",
|
|
4928
4928
|
"member": "string",
|
|
4929
4929
|
"name": "DbName",
|
|
4930
|
-
"
|
|
4930
|
+
"output_required": true,
|
|
4931
4931
|
"type": "string",
|
|
4932
4932
|
"value_allowed_null": true
|
|
4933
4933
|
},
|
|
@@ -4937,7 +4937,17 @@
|
|
|
4937
4937
|
"example": "bind",
|
|
4938
4938
|
"member": "string",
|
|
4939
4939
|
"name": "ValidStatus",
|
|
4940
|
-
"
|
|
4940
|
+
"output_required": true,
|
|
4941
|
+
"type": "string",
|
|
4942
|
+
"value_allowed_null": true
|
|
4943
|
+
},
|
|
4944
|
+
{
|
|
4945
|
+
"disabled": false,
|
|
4946
|
+
"document": "绑定的类型\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
4947
|
+
"example": "binded",
|
|
4948
|
+
"member": "string",
|
|
4949
|
+
"name": "BindType",
|
|
4950
|
+
"output_required": false,
|
|
4941
4951
|
"type": "string",
|
|
4942
4952
|
"value_allowed_null": true
|
|
4943
4953
|
}
|
|
@@ -7741,7 +7751,7 @@
|
|
|
7741
7751
|
},
|
|
7742
7752
|
{
|
|
7743
7753
|
"disabled": false,
|
|
7744
|
-
"document": "过滤项。支持模糊搜索：（TemplateId，TemplateName）支持过滤：Source：模板来源，system / userUseType：模板类型，auto，semi-auto，law等Status：模板启用状态，draft / launched",
|
|
7754
|
+
"document": "过滤项。支持模糊搜索：（TemplateId，TemplateName）支持过滤：Source：模板来源，system / userUseType：模板类型，auto，semi-auto，law等Status：模板启用状态，draft / launched，ComplianceId：关联的分类分级模版id",
|
|
7745
7755
|
"example": "无",
|
|
7746
7756
|
"member": "DspaAssessmentFilter",
|
|
7747
7757
|
"name": "Filters",
|
|
@@ -337,9 +337,9 @@
|
|
|
337
337
|
"status": "online"
|
|
338
338
|
},
|
|
339
339
|
"CreateUserVerifyUrl": {
|
|
340
|
-
"document": "
|
|
340
|
+
"document": "生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。\n\n注： 调用此接口需要购买<font color=\"red\"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。",
|
|
341
341
|
"input": "CreateUserVerifyUrlRequest",
|
|
342
|
-
"name": "
|
|
342
|
+
"name": "获取个人用户实名链接",
|
|
343
343
|
"output": "CreateUserVerifyUrlResponse",
|
|
344
344
|
"status": "online"
|
|
345
345
|
},
|
|
@@ -442,9 +442,9 @@
|
|
|
442
442
|
"status": "online"
|
|
443
443
|
},
|
|
444
444
|
"DescribeFlowComponents": {
|
|
445
|
-
"document": "
|
|
445
|
+
"document": "可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容，包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。",
|
|
446
446
|
"input": "DescribeFlowComponentsRequest",
|
|
447
|
-
"name": "
|
|
447
|
+
"name": "查询合同的填写控件信息",
|
|
448
448
|
"output": "DescribeFlowComponentsResponse",
|
|
449
449
|
"status": "online"
|
|
450
450
|
},
|
|
@@ -526,7 +526,7 @@
|
|
|
526
526
|
"status": "online"
|
|
527
527
|
},
|
|
528
528
|
"DescribeThirdPartyAuthCode": {
|
|
529
|
-
"document": "通过AuthCode查询个人用户是否实名\n\n\n注意: \n<ul>\n<li
|
|
529
|
+
"document": "通过AuthCode查询个人用户是否实名\n\n\n注意: \n<ul>\n<li>此接口为合作引流场景使用，使用<b>有白名单限制</b>，使用前请联系对接的客户经理沟通。</li>\n<li><b>AuthCode 只能使用一次</b>，查询一次再次查询会返回错误</li>\n</ul>",
|
|
530
530
|
"input": "DescribeThirdPartyAuthCodeRequest",
|
|
531
531
|
"name": "通过AuthCode查询个人用户是否实名",
|
|
532
532
|
"output": "DescribeThirdPartyAuthCodeResponse",
|
|
@@ -3517,6 +3517,15 @@
|
|
|
3517
3517
|
"name": "NeedSignReview",
|
|
3518
3518
|
"required": false,
|
|
3519
3519
|
"type": "bool"
|
|
3520
|
+
},
|
|
3521
|
+
{
|
|
3522
|
+
"disabled": false,
|
|
3523
|
+
"document": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:",
|
|
3524
|
+
"example": "1",
|
|
3525
|
+
"member": "int64",
|
|
3526
|
+
"name": "FlowDisplayType",
|
|
3527
|
+
"required": false,
|
|
3528
|
+
"type": "int"
|
|
3520
3529
|
}
|
|
3521
3530
|
],
|
|
3522
3531
|
"type": "object"
|
|
@@ -4247,6 +4256,15 @@
|
|
|
4247
4256
|
"name": "CallbackUrl",
|
|
4248
4257
|
"required": false,
|
|
4249
4258
|
"type": "string"
|
|
4259
|
+
},
|
|
4260
|
+
{
|
|
4261
|
+
"disabled": false,
|
|
4262
|
+
"document": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： \n <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>\n\n效果如下:\n",
|
|
4263
|
+
"example": "1",
|
|
4264
|
+
"member": "int64",
|
|
4265
|
+
"name": "FlowDisplayType",
|
|
4266
|
+
"required": false,
|
|
4267
|
+
"type": "int"
|
|
4250
4268
|
}
|
|
4251
4269
|
],
|
|
4252
4270
|
"type": "object"
|
|
@@ -4386,7 +4404,7 @@
|
|
|
4386
4404
|
},
|
|
4387
4405
|
{
|
|
4388
4406
|
"disabled": false,
|
|
4389
|
-
"document": "流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。\n\n注:\n`1.
|
|
4407
|
+
"document": "流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。\n\n注:\n`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`\n`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`",
|
|
4390
4408
|
"example": "无",
|
|
4391
4409
|
"member": "FlowCreateApprover",
|
|
4392
4410
|
"name": "FlowApproverInfos",
|
|
@@ -7026,7 +7044,7 @@
|
|
|
7026
7044
|
"members": [
|
|
7027
7045
|
{
|
|
7028
7046
|
"disabled": false,
|
|
7029
|
-
"document": "
|
|
7047
|
+
"document": "腾讯电子签小程序的实名认证链接。 如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。\n\n<b>1.如果EndPoint是APP</b>，\n得到的链接类似于<a href=\"\">pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<b>2.如果EndPoint是HTTP</b>，\n得到的链接类似于<a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署\n\n<b>3.如果EndPoint是HTTP_SHORT_URL</b>，\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署\n\n注： <font color=\"red\">生成的链路后面不能再增加参数</font>\n",
|
|
7030
7048
|
"example": "无",
|
|
7031
7049
|
"member": "string",
|
|
7032
7050
|
"name": "Url",
|
|
@@ -7036,7 +7054,7 @@
|
|
|
7036
7054
|
},
|
|
7037
7055
|
{
|
|
7038
7056
|
"disabled": false,
|
|
7039
|
-
"document": "
|
|
7057
|
+
"document": "链接失效期限，为Unix时间戳（单位秒），有如下规则：\n\n<ul>\n<li>如果指定更换绑定手机号的用户(指定用户ID或姓名等信息)，则设定的链接失效期限为7天后。</li>\n<li>如果没有指定更换绑定手机号的用户，则生成通用跳转到个人换手机号的界面，链接不会过期。</li>\n</ul>",
|
|
7040
7058
|
"example": "无",
|
|
7041
7059
|
"member": "int64",
|
|
7042
7060
|
"name": "ExpireTime",
|
|
@@ -7112,7 +7130,7 @@
|
|
|
7112
7130
|
},
|
|
7113
7131
|
{
|
|
7114
7132
|
"disabled": false,
|
|
7115
|
-
"document": "要跳转的链接类型\n\n
|
|
7133
|
+
"document": "要跳转的链接类型\n\n<ul>\n<li><strong>HTTP</strong>：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>\n<li><strong>HTTP_SHORT_URL</strong>：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>\n<li><strong>APP</strong>：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li>\n<li><strong>H5</strong>：适用于跳转至电子签H5实名页面的长链接</li>\n<li><strong>H5_SHORT_URL</strong>：适用于跳转至电子签H5实名页面的短链接</li>\n</ul>\n\n注：如果不传递，默认值是 <font color=\"red\"> APP </font>",
|
|
7116
7134
|
"example": "APP",
|
|
7117
7135
|
"member": "string",
|
|
7118
7136
|
"name": "Endpoint",
|
|
@@ -7145,7 +7163,7 @@
|
|
|
7145
7163
|
"members": [
|
|
7146
7164
|
{
|
|
7147
7165
|
"disabled": false,
|
|
7148
|
-
"document": "腾讯电子签小程序的实名认证链接。\n如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。\n\n
|
|
7166
|
+
"document": "腾讯电子签小程序的实名认证链接。\n如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。\n\n<strong>1.如果EndPoint是APP</strong>：\n得到的链接类似于<a href=\"\">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<strong>2.如果EndPoint是HTTP</strong>：\n得到的链接类似于 <a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>：\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>4.如果EndPoint是H5</strong>：\n得到的链接类似于 <a href=\"\">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>，点击后会跳转到腾讯电子签H5页面进行签署\n\n<strong>5.如果EndPoint是H5_SHORT_URL</strong>：\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签H5页面进行签署\n\n\n`注：` <font color=\"red\">生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数</font>\n示例值：https://essurl.cn/2n**42Nd",
|
|
7149
7167
|
"example": "无",
|
|
7150
7168
|
"member": "string",
|
|
7151
7169
|
"name": "UserVerifyUrl",
|
|
@@ -7155,7 +7173,7 @@
|
|
|
7155
7173
|
},
|
|
7156
7174
|
{
|
|
7157
7175
|
"disabled": false,
|
|
7158
|
-
"document": "
|
|
7176
|
+
"document": "链接过期时间，为Unix时间戳（单位为秒）。",
|
|
7159
7177
|
"example": "无",
|
|
7160
7178
|
"member": "int64",
|
|
7161
7179
|
"name": "ExpireTime",
|
|
@@ -8220,7 +8238,7 @@
|
|
|
8220
8238
|
},
|
|
8221
8239
|
{
|
|
8222
8240
|
"disabled": false,
|
|
8223
|
-
"document": "合同流程ID，为32位字符串。\n
|
|
8241
|
+
"document": "合同流程ID，为32位字符串。\n\n[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)",
|
|
8224
8242
|
"example": "无",
|
|
8225
8243
|
"member": "string",
|
|
8226
8244
|
"name": "FlowId",
|
|
@@ -8244,7 +8262,7 @@
|
|
|
8244
8262
|
"members": [
|
|
8245
8263
|
{
|
|
8246
8264
|
"disabled": false,
|
|
8247
|
-
"document": "
|
|
8265
|
+
"document": "合同流程关联的填写控件信息，包括填写控件的归属方以及是否填写等内容。\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
8248
8266
|
"example": "无",
|
|
8249
8267
|
"member": "RecipientComponentInfo",
|
|
8250
8268
|
"name": "RecipientComponentInfos",
|
|
@@ -11044,6 +11062,15 @@
|
|
|
11044
11062
|
"name": "AutoSignScene",
|
|
11045
11063
|
"required": false,
|
|
11046
11064
|
"type": "string"
|
|
11065
|
+
},
|
|
11066
|
+
{
|
|
11067
|
+
"disabled": false,
|
|
11068
|
+
"document": "在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:",
|
|
11069
|
+
"example": "1",
|
|
11070
|
+
"member": "int64",
|
|
11071
|
+
"name": "FlowDisplayType",
|
|
11072
|
+
"required": false,
|
|
11073
|
+
"type": "int"
|
|
11047
11074
|
}
|
|
11048
11075
|
],
|
|
11049
11076
|
"usage": "in"
|
|
@@ -12915,7 +12942,7 @@
|
|
|
12915
12942
|
"members": [
|
|
12916
12943
|
{
|
|
12917
12944
|
"disabled": false,
|
|
12918
|
-
"document": "
|
|
12945
|
+
"document": "签署方经办人在合同流程中的参与方ID，与控件绑定，是控件的归属方\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
12919
12946
|
"example": "无",
|
|
12920
12947
|
"member": "string",
|
|
12921
12948
|
"name": "RecipientId",
|
|
@@ -12925,7 +12952,7 @@
|
|
|
12925
12952
|
},
|
|
12926
12953
|
{
|
|
12927
12954
|
"disabled": false,
|
|
12928
|
-
"document": "参与方填写状态\n<ul
|
|
12955
|
+
"document": "参与方填写状态\n<ul>\n<li>**空值** : 此参与方没有填写控件</li>\n<li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>\n<li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>\n\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
12929
12956
|
"example": "无",
|
|
12930
12957
|
"member": "string",
|
|
12931
12958
|
"name": "RecipientFillStatus",
|
|
@@ -12945,7 +12972,7 @@
|
|
|
12945
12972
|
},
|
|
12946
12973
|
{
|
|
12947
12974
|
"disabled": false,
|
|
12948
|
-
"document": "
|
|
12975
|
+
"document": "改参与方填写控件信息列表\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
12949
12976
|
"example": "无",
|
|
12950
12977
|
"member": "FilledComponent",
|
|
12951
12978
|
"name": "Components",
|
|
@@ -12961,33 +12988,39 @@
|
|
|
12961
12988
|
"members": [
|
|
12962
12989
|
{
|
|
12963
12990
|
"disabled": false,
|
|
12964
|
-
"document": "
|
|
12991
|
+
"document": "法人姓名\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
12965
12992
|
"example": "无",
|
|
12966
12993
|
"member": "string",
|
|
12967
12994
|
"name": "LegalName",
|
|
12995
|
+
"output_required": false,
|
|
12968
12996
|
"required": true,
|
|
12969
|
-
"type": "string"
|
|
12997
|
+
"type": "string",
|
|
12998
|
+
"value_allowed_null": true
|
|
12970
12999
|
},
|
|
12971
13000
|
{
|
|
12972
13001
|
"disabled": true,
|
|
12973
|
-
"document": "
|
|
13002
|
+
"document": "社会统一信用代码\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
12974
13003
|
"example": "无",
|
|
12975
13004
|
"member": "string",
|
|
12976
13005
|
"name": "Uscc",
|
|
13006
|
+
"output_required": false,
|
|
12977
13007
|
"required": false,
|
|
12978
|
-
"type": "string"
|
|
13008
|
+
"type": "string",
|
|
13009
|
+
"value_allowed_null": true
|
|
12979
13010
|
},
|
|
12980
13011
|
{
|
|
12981
13012
|
"disabled": false,
|
|
12982
|
-
"document": "
|
|
13013
|
+
"document": "社会统一信用代码\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
12983
13014
|
"example": "无",
|
|
12984
13015
|
"member": "string",
|
|
12985
13016
|
"name": "UnifiedSocialCreditCode",
|
|
13017
|
+
"output_required": false,
|
|
12986
13018
|
"required": false,
|
|
12987
|
-
"type": "string"
|
|
13019
|
+
"type": "string",
|
|
13020
|
+
"value_allowed_null": true
|
|
12988
13021
|
}
|
|
12989
13022
|
],
|
|
12990
|
-
"usage": "
|
|
13023
|
+
"usage": "both"
|
|
12991
13024
|
},
|
|
12992
13025
|
"RegistrationOrganizationInfo": {
|
|
12993
13026
|
"document": "企业认证信息参数， 需要保证这些参数跟营业执照中的信息一致。",
|
|
@@ -172,6 +172,12 @@
|
|
|
172
172
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"ClientIp\": \"1.2.3.4\",\n \"UserId\": \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n },\n \"FlowApproverInfo\": {\n \"ApproverType\": 1,\n \"ApproverMobile\": \"13200000000\",\n \"ApproverName\": \"典子谦\",\n \"ApproverIdCardNumber\": \"620000198802020000\",\n \"ApproverIdCardType\": \"ID_CARD\"\n }\n}",
|
|
173
173
|
"output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"流程ID和合同组ID不能同时为空，请检查参数后再试\"\n },\n \"RequestId\": \"s17007***76147\"\n }\n}",
|
|
174
174
|
"title": "错误示例，为个人用户生成H5批量签署链接，没有指定合同流程ID信息，也没有指定合同组ID信息"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"document": "1. 创建批量签署链接的合同签署方，必须都是动态签署人且未补充。\n2. 批量签署的合同数量不少于1份，不超过100份\n3. 上述合同签署方类型必须一致，均为待C端签署人签署状态\n4. 企业已经购买了专业版或以上版本套餐",
|
|
178
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBatchQuickSignUrl\n<公共请求参数>\n\n{\n \"ApproverSignTypes\": [\n 1,\n 3\n ],\n \"FlowApproverInfo\": {\n \"ApproverType\": 1\n },\n \"FlowIds\": [\n \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\"\n ],\n \"JumpUrl\": \"https://abc.com\",\n \"SignatureTypes\": [\n 0,\n 1\n ]\n}",
|
|
179
|
+
"output": "{\n \"Response\": {\n \"FlowApproverUrlInfo\": {\n \"ApproverMobile\": \"\",\n \"ApproverName\": \"\",\n \"ApproverType\": 1,\n \"LongUrl\": \"https://quick.qian.tencent.cn/guide?Code=yDwiB**FOE&CodeType=QUICK&shortKey=yDwiB**1e5&token=Rg0**Q\",\n \"SignUrl\": \"https://essurl.cn/Rg0**Q\"\n },\n \"RequestId\": \"s1698**9686\"\n }\n}",
|
|
180
|
+
"title": "发起合同后，获取C端签署人的H5批量领取链接"
|
|
175
181
|
}
|
|
176
182
|
],
|
|
177
183
|
"CreateBatchSignUrl": [
|
|
@@ -1300,7 +1306,7 @@
|
|
|
1300
1306
|
{
|
|
1301
1307
|
"document": "1.查询流程填写控件\n2.流程参与方yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj所有的控件都填写完成\n3.流程参与方yDxZzUyKQDKuigUuO4zjEC4rpqaa8QgB、yDxZzUyKQDKuihUuO4zjEy09jfapyHjn没有填写控件",
|
|
1302
1308
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFlowComponents\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n },\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"\n}",
|
|
1303
|
-
"output": "{\n \"Response\": {\n \"RecipientComponentInfos\": [\n {\n \"Components\": [\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_13\",\n \"ComponentName\": \"多行文本\",\n \"ComponentValue\": \"
|
|
1309
|
+
"output": "{\n \"Response\": {\n \"RecipientComponentInfos\": [\n {\n \"Components\": [\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_13\",\n \"ComponentName\": \"多行文本\",\n \"ComponentValue\": \"转让期限：自2023年9月21日起至2025年9月30日\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_12\",\n \"ComponentName\": \"单行文本\",\n \"ComponentValue\": \"伍仟元整\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_14\",\n \"ComponentName\": \"勾选框\",\n \"ComponentValue\": \"true\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_16\",\n \"ComponentName\": \"数字\",\n \"ComponentValue\": \"5000\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_15\",\n \"ComponentName\": \"选择器\",\n \"ComponentValue\": \"选项1\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_17\",\n \"ComponentName\": \"图片\",\n \"ComponentValue\": \"yDRSRUUgygj6qnwfUuO4zjEwc193c2hH\",\n \"ImageUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/yDRSRUUgygj6qnwfUuO4zjEwc193c2hH/0.PNG?hkey=a45a3e727c637df7826f9\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_19\",\n \"ComponentName\": \"日期\",\n \"ComponentValue\": \"2023年06月15日\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_20\",\n \"ComponentName\": \"地址\",\n \"ComponentValue\": \"广东省深圳市南山区海天二路33号\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_21\",\n \"ComponentName\": \"邮箱\",\n \"ComponentValue\": \"himer@xisi.com\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_22\",\n \"ComponentName\": \"学历\",\n \"ComponentValue\": \"小学\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_23\",\n \"ComponentName\": \"性别\",\n \"ComponentValue\": \"男\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n },\n {\n \"ComponentFillStatus\": \"1\",\n \"ComponentId\": \"ComponentId_24\",\n \"ComponentName\": \"省市区\",\n \"ComponentValue\": \"广东省\",\n \"ComponentRecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\",\n \"ImageUrl\": \"\"\n }\n ],\n \"IsPromoter\": true,\n \"RecipientFillStatus\": \"1\",\n \"RecipientId\": \"yDwJ2UUckpk1rwrdUrWKfEcuxn5DMpmj\"\n },\n {\n \"Components\": [],\n \"IsPromoter\": false,\n \"RecipientFillStatus\": \"\",\n \"RecipientId\": \"yDxZzUyKQDKuigUuO4zjEC4rpqaa8QgB\"\n },\n {\n \"Components\": [],\n \"IsPromoter\": false,\n \"RecipientFillStatus\": \"\",\n \"RecipientId\": \"yDxZzUyKQDKuihUuO4zjEy09jfapyHjn\"\n }\n ],\n \"RequestId\": \"d245a68d-e13b-xxxx-xxxx-e5adc794db24\"\n }\n}",
|
|
1304
1310
|
"title": "查询流程填写控件"
|
|
1305
1311
|
}
|
|
1306
1312
|
],
|