tccli 3.0.1190.1__py2.py3-none-any.whl → 3.0.1192.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/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/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 +13 -4
- tccli/services/cfw/cfw_client.py +53 -0
- tccli/services/cfw/v20190904/api.json +473 -0
- tccli/services/cfw/v20190904/examples.json +8 -0
- tccli/services/ckafka/ckafka_client.py +53 -0
- tccli/services/ckafka/v20190819/api.json +80 -0
- tccli/services/ckafka/v20190819/examples.json +8 -0
- tccli/services/cls/v20201016/examples.json +1 -1
- 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 +298 -45
- tccli/services/dlc/v20210125/examples.json +21 -21
- tccli/services/dsgc/v20190723/api.json +13 -3
- tccli/services/emr/v20190103/api.json +8 -8
- tccli/services/ess/v20201111/api.json +49 -16
- tccli/services/ess/v20201111/examples.json +7 -1
- tccli/services/essbasic/v20210526/api.json +28 -1
- tccli/services/essbasic/v20210526/examples.json +43 -1
- tccli/services/irp/v20220805/api.json +11 -2
- tccli/services/lke/v20231130/api.json +82 -4
- tccli/services/mps/v20190612/api.json +126 -5
- tccli/services/ocr/v20181119/api.json +10 -0
- tccli/services/ocr/v20181119/examples.json +1 -1
- tccli/services/omics/v20221128/api.json +13 -2
- tccli/services/region/v20220627/api.json +11 -11
- tccli/services/region/v20220627/examples.json +1 -1
- 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/tmt/v20180321/api.json +2 -2
- tccli/services/vdb/v20230616/api.json +38 -1
- tccli/services/vdb/v20230616/examples.json +2 -2
- tccli/services/vod/v20180717/api.json +30 -9
- tccli/services/vod/v20180717/examples.json +1 -1
- tccli/services/vpc/v20170312/api.json +3 -3
- tccli/services/wedata/v20210820/api.json +1 -1
- {tccli-3.0.1190.1.dist-info → tccli-3.0.1192.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1190.1.dist-info → tccli-3.0.1192.1.dist-info}/RECORD +61 -51
- {tccli-3.0.1190.1.dist-info → tccli-3.0.1192.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1190.1.dist-info → tccli-3.0.1192.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1190.1.dist-info → tccli-3.0.1192.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
|
}
|
|
@@ -171,7 +171,7 @@
|
|
|
171
171
|
"CreateDataEngine": [
|
|
172
172
|
{
|
|
173
173
|
"document": "创建数据引擎",
|
|
174
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDataEngine\n<公共请求参数>\n\n{\n \"EngineType\": \"spark\",\n \"DataEngineName\": \"test\",\n \"ClusterType\": \"spark\",\n \"MinClusters\": 0,\n \"MaxClusters\": 0,\n \"DefaultDataEngine\": true,\n \"CidrBlock\": \"10.255.255.0/16\",\n \"Mode\": 0,\n \"Message\": \"test\",\n \"AutoResume\": true,\n \"Size\": 0,\n \"PayMode\": 0,\n \"TimeSpan\": 1,\n \"TimeUnit\": \"h\",\n \"AutoRenew\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"key\",\n \"TagValue\": \"value\"\n }\n ],\n \"AutoSuspend\": true,\n \"CrontabResumeSuspend\": 0,\n \"CrontabResumeSuspendStrategy\": {\n \"ResumeTime\": \"10\",\n \"SuspendTime\": \"10\",\n \"SuspendStrategy\": 0\n },\n \"EngineExecType\": \"BATCH\",\n \"MaxConcurrency\":
|
|
174
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDataEngine\n<公共请求参数>\n\n{\n \"EngineType\": \"spark\",\n \"DataEngineName\": \"test\",\n \"ClusterType\": \"spark\",\n \"MinClusters\": 0,\n \"MaxClusters\": 0,\n \"DefaultDataEngine\": true,\n \"CidrBlock\": \"10.255.255.0/16\",\n \"Mode\": 0,\n \"Message\": \"test\",\n \"AutoResume\": true,\n \"Size\": 0,\n \"PayMode\": 0,\n \"TimeSpan\": 1,\n \"TimeUnit\": \"h\",\n \"AutoRenew\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"key\",\n \"TagValue\": \"value\"\n }\n ],\n \"AutoSuspend\": true,\n \"CrontabResumeSuspend\": 0,\n \"CrontabResumeSuspendStrategy\": {\n \"ResumeTime\": \"10\",\n \"SuspendTime\": \"10\",\n \"SuspendStrategy\": 0\n },\n \"EngineExecType\": \"BATCH\",\n \"MaxConcurrency\": 10,\n \"TolerableQueueTime\": 5,\n \"AutoSuspendTime\": 5,\n \"ResourceType\": \"spark_cu\",\n \"ImageVersionName\": \"SuperSQL-P 1.1\"\n}",
|
|
175
175
|
"output": "{\n \"Response\": {\n \"DataEngineId\": \"DataEngine-abc123\",\n \"RequestId\": \"sd01m2-fasfki-231safas\"\n }\n}",
|
|
176
176
|
"title": "创建数据引擎"
|
|
177
177
|
}
|
|
@@ -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
|
],
|
|
@@ -1015,8 +1015,8 @@
|
|
|
1015
1015
|
"QueryResult": [
|
|
1016
1016
|
{
|
|
1017
1017
|
"document": "",
|
|
1018
|
-
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryResult\n<公共请求参数>\n\n{\n \"NextToken\": \"
|
|
1019
|
-
"output": "{\n \"Response\": {\n \"ResultSchema\": [\n {\n \"
|
|
1018
|
+
"input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryResult\n<公共请求参数>\n\n{\n \"NextToken\": \"objectListMarker={marker}&lastReadFile={filename}&lastReadOffset\",\n \"TaskId\": \"20210521195919442157\"\n}",
|
|
1019
|
+
"output": "{\n \"Response\": {\n \"TaskId\": \"abc\",\n \"ResultSet\": \"abc\",\n \"ResultSchema\": [\n {\n \"Name\": \"abc\",\n \"Type\": \"abc\",\n \"Comment\": \"abc\",\n \"Precision\": 0,\n \"Scale\": 0,\n \"Nullable\": \"abc\",\n \"Position\": 0,\n \"CreateTime\": \"abc\",\n \"ModifiedTime\": \"abc\",\n \"IsPartition\": true\n }\n ],\n \"NextToken\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
|
1020
1020
|
"title": "获取任务结果"
|
|
1021
1021
|
}
|
|
1022
1022
|
],
|
|
@@ -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",
|
|
@@ -2221,7 +2221,7 @@
|
|
|
2221
2221
|
},
|
|
2222
2222
|
{
|
|
2223
2223
|
"disabled": false,
|
|
2224
|
-
"document": "唯一随机标识，时效性为5分钟，需要调用者指定 防止客户端重复创建资源，例如 a9a90aa6
|
|
2224
|
+
"document": "唯一随机标识，时效性为5分钟，需要调用者指定 防止客户端重复创建资源，例如 a9a90aa6-****-****-****-fae360632808",
|
|
2225
2225
|
"example": "sdcdwxxxws",
|
|
2226
2226
|
"member": "string",
|
|
2227
2227
|
"name": "ClientToken",
|
|
@@ -2492,8 +2492,8 @@
|
|
|
2492
2492
|
},
|
|
2493
2493
|
{
|
|
2494
2494
|
"disabled": false,
|
|
2495
|
-
"document": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6
|
|
2496
|
-
"example": "a9a90aa6
|
|
2495
|
+
"document": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-****-****-****-fae36063280",
|
|
2496
|
+
"example": "a9a90aa6-****-****-****-fae36063280",
|
|
2497
2497
|
"member": "string",
|
|
2498
2498
|
"name": "ClientToken",
|
|
2499
2499
|
"required": false,
|
|
@@ -4937,7 +4937,7 @@
|
|
|
4937
4937
|
},
|
|
4938
4938
|
{
|
|
4939
4939
|
"disabled": false,
|
|
4940
|
-
"document": "
|
|
4940
|
+
"document": "服务组件名称，都是大写例如YARN",
|
|
4941
4941
|
"example": "无",
|
|
4942
4942
|
"member": "string",
|
|
4943
4943
|
"name": "ServiceName",
|
|
@@ -12340,8 +12340,8 @@
|
|
|
12340
12340
|
},
|
|
12341
12341
|
{
|
|
12342
12342
|
"disabled": false,
|
|
12343
|
-
"document": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6
|
|
12344
|
-
"example": "
|
|
12343
|
+
"document": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-****-****-****-fae36063280",
|
|
12344
|
+
"example": "a9a90aa6-****-****-****-fae36063280",
|
|
12345
12345
|
"member": "string",
|
|
12346
12346
|
"name": "ClientToken",
|
|
12347
12347
|
"required": false,
|
|
@@ -12587,8 +12587,8 @@
|
|
|
12587
12587
|
},
|
|
12588
12588
|
{
|
|
12589
12589
|
"disabled": false,
|
|
12590
|
-
"document": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6
|
|
12591
|
-
"example": "a9a90aa6
|
|
12590
|
+
"document": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-****-****-****-fae36063280",
|
|
12591
|
+
"example": "a9a90aa6-****-****-****-fae36063280",
|
|
12592
12592
|
"member": "string",
|
|
12593
12593
|
"name": "ClientToken",
|
|
12594
12594
|
"required": false,
|
|
@@ -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
|
},
|
|
@@ -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",
|
|
@@ -7676,7 +7694,7 @@
|
|
|
7676
7694
|
},
|
|
7677
7695
|
{
|
|
7678
7696
|
"disabled": false,
|
|
7679
|
-
"document": "查询的套餐类型 （选填 ）不传则查询所有套餐；\n目前支持:\n<ul>\n<li>**CloudEnterprise**: 企业版合同</li>\n<li>**SingleSignature**: 单方签章</li>\n<li>**CloudProve**: 签署报告</li>\n<li>**CloudOnlineSign**: 腾讯会议在线签约</li>\n<li>**ChannelWeCard**: 微工卡</li>\n<li>**SignFlow**: 合同套餐</li>\n<li>**SignFace**: 签署意愿（人脸识别）</li>\n<li>**SignPassword**: 签署意愿（密码）</li>\n<li>**SignSMS**: 签署意愿（短信）</li>\n<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>\n<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>\n<li>**OrgEssAuth**: 签署企业实名</li>\n<li>**FlowNotify**: 短信通知</li>\n<li>**AuthService**: 企业工商信息查询</li>\n</ul>",
|
|
7697
|
+
"document": "查询的套餐类型 （选填 ）不传则查询所有套餐；\n目前支持:\n<ul>\n<li>**CloudEnterprise**: 企业版合同</li>\n<li>**SingleSignature**: 单方签章</li>\n<li>**CloudProve**: 签署报告</li>\n<li>**CloudOnlineSign**: 腾讯会议在线签约</li>\n<li>**ChannelWeCard**: 微工卡</li>\n<li>**SignFlow**: 合同套餐</li>\n<li>**SignFace**: 签署意愿（人脸识别）</li>\n<li>**SignPassword**: 签署意愿（密码）</li>\n<li>**SignSMS**: 签署意愿（短信）</li>\n<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>\n<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>\n<li>**OrgEssAuth**: 签署企业实名</li>\n<li>**FlowNotify**: 短信通知</li>\n<li>**AuthService**: 企业工商信息查询</li>\n<li>**NoAuthSign**: 形式签</li>\n</ul>",
|
|
7680
7698
|
"example": "CloudEnterprise",
|
|
7681
7699
|
"member": "string",
|
|
7682
7700
|
"name": "QuotaType",
|
|
@@ -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": "企业认证信息参数， 需要保证这些参数跟营业执照中的信息一致。",
|