tccli 3.0.1163.1__py2.py3-none-any.whl → 3.0.1165.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/aiart/v20221229/api.json +5 -5
- tccli/services/cbs/v20170312/api.json +1 -1
- tccli/services/cdb/v20170320/api.json +48 -12
- tccli/services/cdwdoris/cdwdoris_client.py +1260 -94
- tccli/services/cdwdoris/v20211228/api.json +3331 -617
- tccli/services/cdwdoris/v20211228/examples.json +176 -0
- tccli/services/cfs/v20190719/api.json +56 -9
- tccli/services/csip/v20221121/api.json +20 -0
- tccli/services/emr/v20190103/api.json +21 -3
- tccli/services/emr/v20190103/examples.json +2 -2
- tccli/services/ess/v20201111/api.json +6 -6
- tccli/services/ess/v20201111/examples.json +3 -3
- tccli/services/essbasic/v20210526/api.json +4 -4
- tccli/services/essbasic/v20210526/examples.json +1 -1
- tccli/services/hunyuan/v20230901/api.json +10 -1
- tccli/services/hunyuan/v20230901/examples.json +1 -1
- tccli/services/iotexplorer/iotexplorer_client.py +110 -4
- tccli/services/iotexplorer/v20190423/api.json +190 -0
- tccli/services/iotexplorer/v20190423/examples.json +59 -1
- tccli/services/lcic/v20220817/api.json +20 -0
- tccli/services/monitor/v20180724/api.json +13 -13
- tccli/services/monitor/v20180724/examples.json +8 -8
- tccli/services/mps/v20190612/api.json +20 -0
- tccli/services/mps/v20190612/examples.json +2 -2
- tccli/services/organization/organization_client.py +53 -0
- tccli/services/organization/v20210331/api.json +208 -0
- tccli/services/organization/v20210331/examples.json +8 -0
- tccli/services/rce/rce_client.py +477 -0
- tccli/services/rce/v20201103/api.json +1749 -231
- tccli/services/rce/v20201103/examples.json +72 -0
- tccli/services/redis/redis_client.py +114 -8
- tccli/services/redis/v20180412/api.json +392 -0
- tccli/services/redis/v20180412/examples.json +17 -1
- tccli/services/sqlserver/sqlserver_client.py +53 -0
- tccli/services/sqlserver/v20180328/api.json +34 -0
- tccli/services/sqlserver/v20180328/examples.json +8 -0
- tccli/services/tmt/v20180321/api.json +2 -2
- tccli/services/trtc/v20190722/api.json +14 -6
- tccli/services/tse/v20201207/api.json +11 -0
- tccli/services/tsi/v20210325/api.json +5 -5
- {tccli-3.0.1163.1.dist-info → tccli-3.0.1165.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1163.1.dist-info → tccli-3.0.1165.1.dist-info}/RECORD +46 -46
- {tccli-3.0.1163.1.dist-info → tccli-3.0.1165.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1163.1.dist-info → tccli-3.0.1165.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1163.1.dist-info → tccli-3.0.1165.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"actions": {
|
|
3
|
+
"CancelBackupJob": [
|
|
4
|
+
{
|
|
5
|
+
"document": "",
|
|
6
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CancelBackupJob\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"BackUpJobId\": 0\n}",
|
|
7
|
+
"output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
|
8
|
+
"title": "test"
|
|
9
|
+
}
|
|
10
|
+
],
|
|
11
|
+
"CreateBackUpSchedule": [
|
|
12
|
+
{
|
|
13
|
+
"document": "",
|
|
14
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateBackUpSchedule\n<公共请求参数>\n\n{\n \"ScheduleId\": 0,\n \"WeekDays\": \"1\",\n \"BackUpTables\": [\n {\n \"Table\": \"1\",\n \"TotalBytes\": 0,\n \"Database\": \"1\"\n }\n ],\n \"ExecuteHour\": 0\n}",
|
|
15
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1\"\n }\n}",
|
|
16
|
+
"title": "示例"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
3
19
|
"CreateInstanceNew": [
|
|
4
20
|
{
|
|
5
21
|
"document": "创建集群",
|
|
@@ -16,6 +32,14 @@
|
|
|
16
32
|
"title": "创建资源组"
|
|
17
33
|
}
|
|
18
34
|
],
|
|
35
|
+
"DeleteBackUpData": [
|
|
36
|
+
{
|
|
37
|
+
"document": "",
|
|
38
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteBackUpData\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"BackUpJobId\": 0\n}",
|
|
39
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
|
|
40
|
+
"title": "示例"
|
|
41
|
+
}
|
|
42
|
+
],
|
|
19
43
|
"DeleteWorkloadGroup": [
|
|
20
44
|
{
|
|
21
45
|
"document": "",
|
|
@@ -24,6 +48,54 @@
|
|
|
24
48
|
"title": "删除资源组"
|
|
25
49
|
}
|
|
26
50
|
],
|
|
51
|
+
"DescribeAreaRegion": [
|
|
52
|
+
{
|
|
53
|
+
"document": "集群列表页上显示地域信息及各个地域的集群总数",
|
|
54
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAreaRegion\n<公共请求参数>\n\n{}",
|
|
55
|
+
"output": "{\n \"Response\": {\n \"Items\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"Regions\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"RegionId\": 0,\n \"Zones\": [\n {\n \"Name\": \"abc\",\n \"Desc\": \"abc\",\n \"ZoneId\": 0,\n \"Encrypt\": 0\n }\n ],\n \"Count\": 0,\n \"IsInternationalSite\": 1,\n \"Bucket\": \"abc\"\n }\n ]\n }\n ],\n \"FrontEndRules\": [\n {\n \"ID\": 0,\n \"Name\": \"abc\",\n \"Rule\": \"abc\"\n }\n ],\n \"AvailableWhiteListNames\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
56
|
+
"title": "获取各地域列表"
|
|
57
|
+
}
|
|
58
|
+
],
|
|
59
|
+
"DescribeBackUpJob": [
|
|
60
|
+
{
|
|
61
|
+
"document": "",
|
|
62
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackUpJob\n<公共请求参数>\n\n{\n \"InstanceId\": \"1\",\n \"PageNum\": 0,\n \"PageSize\": 0\n}",
|
|
63
|
+
"output": "{\n \"Response\": {\n \"BackUpJobs\": [\n {\n \"JobId\": 0,\n \"Snapshot\": \"abc\",\n \"BackUpSize\": 0,\n \"BackUpTime\": \"abc\",\n \"ExpireTime\": \"abc\",\n \"JobStatus\": \"abc\",\n \"BackupType\": 0,\n \"BackupTimeType\": 0,\n \"DorisSourceInfo\": {\n \"Host\": \"abc\",\n \"Port\": 0,\n \"User\": \"abc\",\n \"Password\": \"abc\"\n },\n \"JobStatusNum\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
64
|
+
"title": "示例"
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"DescribeBackUpJobDetail": [
|
|
68
|
+
{
|
|
69
|
+
"document": "",
|
|
70
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackUpJobDetail\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"BackUpJobId\": 0\n}",
|
|
71
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xx\",\n \"TableContents\": [\n {\n \"Table\": \"xx\",\n \"TotalBytes\": 0,\n \"Database\": \"xx\"\n }\n ]\n }\n}",
|
|
72
|
+
"title": "示例"
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
"DescribeBackUpSchedules": [
|
|
76
|
+
{
|
|
77
|
+
"document": "",
|
|
78
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackUpSchedules\n<公共请求参数>\n\n{}",
|
|
79
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
|
|
80
|
+
"title": "获取备份、迁移任务"
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"DescribeBackUpTables": [
|
|
84
|
+
{
|
|
85
|
+
"document": "",
|
|
86
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackUpTables\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-123\"\n}",
|
|
87
|
+
"output": "{\n \"Response\": {\n \"AvailableTables\": [\n {\n \"Table\": \"tablename1\",\n \"TotalBytes\": 0,\n \"Database\": \"db1\"\n }\n ],\n \"RequestId\": \"request1\"\n }\n}",
|
|
88
|
+
"title": "示例"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"DescribeBackUpTaskDetail": [
|
|
92
|
+
{
|
|
93
|
+
"document": "",
|
|
94
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackUpTaskDetail\n<公共请求参数>\n\n{\n \"InstanceId\": \"xx\",\n \"BackUpJobId\": 0\n}",
|
|
95
|
+
"output": "{\n \"Response\": {\n \"ErrorMsg\": \"xx\",\n \"BackupStatus\": [\n {\n \"Status\": \"xx\",\n \"FinishedTime\": \"xx\",\n \"BackupObjects\": \"xx\",\n \"SnapshotName\": \"xx\",\n \"TaskErrMsg\": \"xx\",\n \"JobId\": 0,\n \"UnfinishedTasks\": \"xx\",\n \"State\": \"xx\",\n \"SnapshotFinishedTime\": \"xx\",\n \"Timeout\": 0,\n \"UploadFinishedTime\": \"xx\",\n \"Progress\": \"xx\",\n \"CreateTime\": \"xx\",\n \"DbName\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
|
|
96
|
+
"title": "示例"
|
|
97
|
+
}
|
|
98
|
+
],
|
|
27
99
|
"DescribeClusterConfigs": [
|
|
28
100
|
{
|
|
29
101
|
"document": "在xml方式下修改配置文件内容时，获取集群配置文件内容",
|
|
@@ -32,6 +104,14 @@
|
|
|
32
104
|
"title": "获取集群配置文件内容"
|
|
33
105
|
}
|
|
34
106
|
],
|
|
107
|
+
"DescribeClusterConfigsHistory": [
|
|
108
|
+
{
|
|
109
|
+
"document": "",
|
|
110
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterConfigsHistory\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ConfigFileNames\": [\n \"abc\"\n ],\n \"Offset\": 0,\n \"Limit\": 0,\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\"\n}",
|
|
111
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"ClusterConfHistory\": [\n {\n \"FileName\": \"abc\",\n \"NewConfValue\": \"abc\",\n \"OldConfValue\": \"abc\",\n \"Remark\": \"abc\",\n \"ModifyTime\": \"abc\",\n \"UserUin\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
112
|
+
"title": "test"
|
|
113
|
+
}
|
|
114
|
+
],
|
|
35
115
|
"DescribeDatabaseAuditDownload": [
|
|
36
116
|
{
|
|
37
117
|
"document": "下载数据库审计日志",
|
|
@@ -48,6 +128,30 @@
|
|
|
48
128
|
"title": "DescribeDatabaseAuditRecords"
|
|
49
129
|
}
|
|
50
130
|
],
|
|
131
|
+
"DescribeDatabaseAuditResource": [
|
|
132
|
+
{
|
|
133
|
+
"document": "获取审计日志的相关信息",
|
|
134
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDatabaseAuditResource\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\"\n}",
|
|
135
|
+
"output": "{\n \"Response\": {\n \"Databases\": [\n \"abc\"\n ],\n \"Users\": [\n \"abc\"\n ],\n \"SqlTypes\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
136
|
+
"title": "DescribeDatabaseAuditResource"
|
|
137
|
+
}
|
|
138
|
+
],
|
|
139
|
+
"DescribeDmsSqlHistory": [
|
|
140
|
+
{
|
|
141
|
+
"document": "",
|
|
142
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDmsSqlHistory\n<公共请求参数>\n\n{}",
|
|
143
|
+
"output": "{\n \"Response\": {\n \"QueryNodeList\": [\n \"abc\"\n ],\n \"QueryStatusList\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
|
144
|
+
"title": "查询历史执行记录"
|
|
145
|
+
}
|
|
146
|
+
],
|
|
147
|
+
"DescribeDorisMetricFiles": [
|
|
148
|
+
{
|
|
149
|
+
"document": "",
|
|
150
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDorisMetricFiles\n<公共请求参数>\n\n{\n \"ApiType\": \"abc\",\n \"DescribeMetricsFileReq\": {\n \"InstanceType\": \"abc\",\n \"MetricType\": \"abc\",\n \"IfAttention\": 0\n },\n \"ModifyMetricFileReq\": {\n \"Id\": 0,\n \"IfAttention\": \"abc\"\n },\n \"InstanceId\": \"abc\",\n \"ModifyAttentionMetricFileReq\": {\n \"InstanceType\": \"abc\",\n \"MetricType\": \"abc\",\n \"Name\": \"abc\",\n \"IfAttention\": 0\n }\n}",
|
|
151
|
+
"output": "{\n \"Response\": {\n \"ErrorMsg\": \"abc\",\n \"ReturnData\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
|
152
|
+
"title": "DescribeDorisMetricFiles"
|
|
153
|
+
}
|
|
154
|
+
],
|
|
51
155
|
"DescribeFederationToken": [
|
|
52
156
|
{
|
|
53
157
|
"document": "",
|
|
@@ -56,6 +160,14 @@
|
|
|
56
160
|
"title": "获取联合临时密钥"
|
|
57
161
|
}
|
|
58
162
|
],
|
|
163
|
+
"DescribeFrontEnd": [
|
|
164
|
+
{
|
|
165
|
+
"document": "示例",
|
|
166
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFrontEnd\n<公共请求参数>\n\n{}",
|
|
167
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"532418ac-e131-437f-9fe7-4c7d0f3e31c4\"\n }\n}",
|
|
168
|
+
"title": "示例"
|
|
169
|
+
}
|
|
170
|
+
],
|
|
59
171
|
"DescribeGoodsDetail": [
|
|
60
172
|
{
|
|
61
173
|
"document": "生成计费相关接口的GoodsDetail结构",
|
|
@@ -94,6 +206,22 @@
|
|
|
94
206
|
"title": "查询节点角色"
|
|
95
207
|
}
|
|
96
208
|
],
|
|
209
|
+
"DescribeInstanceNodesRole": [
|
|
210
|
+
{
|
|
211
|
+
"document": "查看机器角色信息",
|
|
212
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceNodesRole\n<公共请求参数>\n\n{\n \"InstanceId\": \"1\",\n \"IpFilter\": \"1\"\n}",
|
|
213
|
+
"output": "{\n \"Response\": {\n \"ErrorMsg\": \"1\",\n \"NodeInfos\": [\n {\n \"Status\": 0,\n \"Ip\": \"1\",\n \"NodeRole\": \"1\",\n \"NodeName\": \"1\"\n }\n ],\n \"RequestId\": \"1\",\n \"TotalCount\": 0\n }\n}",
|
|
214
|
+
"title": "DescribeInstanceNodesRole"
|
|
215
|
+
}
|
|
216
|
+
],
|
|
217
|
+
"DescribeInstanceOperations": [
|
|
218
|
+
{
|
|
219
|
+
"document": "获取集群操作列表",
|
|
220
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceOperations\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwch-exs8Mnql\"\n}",
|
|
221
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xxxx-xxxx-xxxxx-xxxxx\",\n \"TotalCount\": 2,\n \"Operations\": [\n {\n \"Name\": \"CreateInstance\",\n \"Desc\": \"创建集群\",\n \"Result\": \"Success\",\n \"Level\": \"Normal\",\n \"LevelDesc\": \"一般\",\n \"StartTime\": \"2020-10-22 13:28:53\",\n \"EndTime\": \"2020-10-22 13:28:53\",\n \"JobId\": 123\n },\n {\n \"Name\": \"ModifyInstance\",\n \"Desc\": \"变配集群\",\n \"Result\": \"Success\",\n \"Level\": \"HighRisk\",\n \"LevelDesc\": \"高危\",\n \"StartTime\": \"2020-10-22 14:38:53\",\n \"EndTime\": \"2020-10-22 14:38:53\",\n \"JobId\": 124\n }\n ]\n }\n}",
|
|
222
|
+
"title": "获取集群操作列表"
|
|
223
|
+
}
|
|
224
|
+
],
|
|
97
225
|
"DescribeInstanceState": [
|
|
98
226
|
{
|
|
99
227
|
"document": "需要展现集群状态以及操作进度",
|
|
@@ -118,6 +246,14 @@
|
|
|
118
246
|
"title": "获取实例列表"
|
|
119
247
|
}
|
|
120
248
|
],
|
|
249
|
+
"DescribeInstancesHealthState": [
|
|
250
|
+
{
|
|
251
|
+
"document": "集群健康检查",
|
|
252
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstancesHealthState\n<公共请求参数>\n\n{\n \"InstanceID\": \"abc\"\n}",
|
|
253
|
+
"output": "{\n \"Response\": {\n \"Data\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
|
254
|
+
"title": "DescribeInstancesHealthState"
|
|
255
|
+
}
|
|
256
|
+
],
|
|
121
257
|
"DescribeRegionZone": [
|
|
122
258
|
{
|
|
123
259
|
"document": "购买页获取地域及可用区列表、内核版本、网络规则等",
|
|
@@ -158,6 +294,14 @@
|
|
|
158
294
|
"title": "DescribeSlowQueryRecordsDownload"
|
|
159
295
|
}
|
|
160
296
|
],
|
|
297
|
+
"DescribeSpec": [
|
|
298
|
+
{
|
|
299
|
+
"document": "购买页拉取集群的数据节点和zookeeper节点的规格列表",
|
|
300
|
+
"input": "https://cdwdoris.tencentcloudapi.com/?Action=DescribeSpec\n&Zone=ap-guangzhou-1\n&<公共请求参数>",
|
|
301
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"10058bc0-40e7-4eb0-9b4d\",\n \"MasterSpec\": [\n {\n \"Name\": \"SCH3\",\n \"Cpu\": 2,\n \"Mem\": 4,\n \"Type\": \"STANDARD\",\n \"DataDisk\": {\n \"DiskCount\": 1,\n \"MaxDiskSize\": 32000,\n \"MinDiskSize\": 100,\n \"DiskType\": \"CLOUD_HSSD\",\n \"DiskDesc\": \"增强型SSD云硬盘\"\n },\n \"SystemDisk\": {\n \"DiskCount\": 1,\n \"MaxDiskSize\": 50,\n \"MinDiskSize\": 50,\n \"DiskType\": \"CLOUD_PREMIUM\",\n \"DiskDesc\": \"高性能云硬盘\"\n },\n \"MaxNodeSize\": 50,\n \"Available\": true,\n \"ComputeSpecDesc\": \"2核4G\"\n }\n ],\n \"CoreSpec\": [\n {\n \"Name\": \"SCH6\",\n \"Cpu\": 4,\n \"Mem\": 16,\n \"Type\": \"STANDARD\",\n \"DataDisk\": {\n \"DiskCount\": 1,\n \"MaxDiskSize\": 32000,\n \"MinDiskSize\": 100,\n \"DiskType\": \"CLOUD_HSSD\",\n \"DiskDesc\": \"增强型SSD云硬盘\"\n },\n \"SystemDisk\": {\n \"DiskCount\": 1,\n \"MaxDiskSize\": 50,\n \"MinDiskSize\": 50,\n \"DiskType\": \"CLOUD_PREMIUM\",\n \"DiskDesc\": \"高性能云硬盘\"\n },\n \"MaxNodeSize\": 50,\n \"Available\": true,\n \"ComputeSpecDesc\": \"4核16G\"\n }\n ],\n \"AttachCBSSpec\": [\n {\n \"DiskCount\": 1,\n \"MaxDiskSize\": 32000,\n \"MinDiskSize\": 100,\n \"DiskType\": \"CLOUD_HSSD\",\n \"DiskDesc\": \"增强型SSD云硬盘\"\n }\n ]\n }\n}",
|
|
302
|
+
"title": "获取集群规格"
|
|
303
|
+
}
|
|
304
|
+
],
|
|
161
305
|
"DescribeSqlApis": [
|
|
162
306
|
{
|
|
163
307
|
"document": "查询ck集群信息",
|
|
@@ -214,6 +358,14 @@
|
|
|
214
358
|
"title": "示例"
|
|
215
359
|
}
|
|
216
360
|
],
|
|
361
|
+
"ModifyNodeStatus": [
|
|
362
|
+
{
|
|
363
|
+
"document": "调整节点状态",
|
|
364
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyNodeStatus\n<公共请求参数>\n\n{\n \"InstanceId\": \"11\",\n \"NodeInfos\": [\n {\n \"Status\": 0,\n \"Ip\": \"11\",\n \"NodeRole\": \"11\",\n \"NodeName\": \"11\"\n }\n ],\n \"OperationCode\": \"11\"\n}",
|
|
365
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xxx-xxx\",\n \"FlowId\": 0,\n \"ErrorMsg\": \"\"\n }\n}",
|
|
366
|
+
"title": "调整节点状态"
|
|
367
|
+
}
|
|
368
|
+
],
|
|
217
369
|
"ModifySecurityGroups": [
|
|
218
370
|
{
|
|
219
371
|
"document": "",
|
|
@@ -254,6 +406,22 @@
|
|
|
254
406
|
"title": "开启或关闭资源组"
|
|
255
407
|
}
|
|
256
408
|
],
|
|
409
|
+
"OpenBackUp": [
|
|
410
|
+
{
|
|
411
|
+
"document": "",
|
|
412
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenBackUp\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-itrbbn1z\",\n \"CosBucketName\": \"carson-test-1301087413\",\n \"OperationType\": \"open\"\n}",
|
|
413
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"3f8a0da4-f950-4ab5-9b20-c347528bd220\"\n }\n}",
|
|
414
|
+
"title": "示例"
|
|
415
|
+
}
|
|
416
|
+
],
|
|
417
|
+
"RecoverBackUpJob": [
|
|
418
|
+
{
|
|
419
|
+
"document": "",
|
|
420
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RecoverBackUpJob\n<公共请求参数>\n\n{\n \"InstanceId\": \"1\",\n \"BackUpJobId\": 0\n}",
|
|
421
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1\"\n }\n}",
|
|
422
|
+
"title": "示例"
|
|
423
|
+
}
|
|
424
|
+
],
|
|
257
425
|
"ReduceInstance": [
|
|
258
426
|
{
|
|
259
427
|
"document": "",
|
|
@@ -270,6 +438,14 @@
|
|
|
270
438
|
"title": "云盘扩容示例"
|
|
271
439
|
}
|
|
272
440
|
],
|
|
441
|
+
"RestartClusterForConfigs": [
|
|
442
|
+
{
|
|
443
|
+
"document": "在集群配置页面修改集群接口",
|
|
444
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RestartClusterForConfigs\n<公共请求参数>\n\n{\n \"InstanceId\": \"1\",\n \"ConfigName\": \"11\"\n}",
|
|
445
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xxx-xxx\",\n \"FlowId\": 0,\n \"ErrorMsg\": \"\"\n }\n}",
|
|
446
|
+
"title": "修改集群配置接口"
|
|
447
|
+
}
|
|
448
|
+
],
|
|
273
449
|
"RestartClusterForNode": [
|
|
274
450
|
{
|
|
275
451
|
"document": "",
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
"status": "online"
|
|
100
100
|
},
|
|
101
101
|
"DeleteUserQuota": {
|
|
102
|
-
"document": "
|
|
102
|
+
"document": "指定条件删除文件系统配额（仅部分Turbo实例能使用，若需要调用请提交工单与我们联系）",
|
|
103
103
|
"input": "DeleteUserQuotaRequest",
|
|
104
104
|
"name": "删除文件系统配额",
|
|
105
105
|
"output": "DeleteUserQuotaResponse",
|
|
@@ -218,7 +218,7 @@
|
|
|
218
218
|
"status": "online"
|
|
219
219
|
},
|
|
220
220
|
"SetUserQuota": {
|
|
221
|
-
"document": "设置文件系统配额，提供UID/GID
|
|
221
|
+
"document": "设置文件系统配额，提供UID/GID的配额设置的接口（仅部分Turbo实例能使用，若需要调用请提交工单与我们联系）",
|
|
222
222
|
"input": "SetUserQuotaRequest",
|
|
223
223
|
"name": "设置文件系统配额",
|
|
224
224
|
"output": "SetUserQuotaResponse",
|
|
@@ -1770,7 +1770,7 @@
|
|
|
1770
1770
|
},
|
|
1771
1771
|
{
|
|
1772
1772
|
"disabled": false,
|
|
1773
|
-
"document": "指定配额类型，包括Uid、Gid",
|
|
1773
|
+
"document": "指定配额类型，包括Uid、Gid、Dir",
|
|
1774
1774
|
"example": "Uid",
|
|
1775
1775
|
"member": "string",
|
|
1776
1776
|
"name": "UserType",
|
|
@@ -1783,7 +1783,16 @@
|
|
|
1783
1783
|
"example": "1000",
|
|
1784
1784
|
"member": "string",
|
|
1785
1785
|
"name": "UserId",
|
|
1786
|
-
"required":
|
|
1786
|
+
"required": false,
|
|
1787
|
+
"type": "string"
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
"disabled": false,
|
|
1791
|
+
"document": "设置目录配额的目录的绝对路径",
|
|
1792
|
+
"example": "/cfs/xx",
|
|
1793
|
+
"member": "string",
|
|
1794
|
+
"name": "DirectoryPath",
|
|
1795
|
+
"required": false,
|
|
1787
1796
|
"type": "string"
|
|
1788
1797
|
}
|
|
1789
1798
|
],
|
|
@@ -3698,7 +3707,7 @@
|
|
|
3698
3707
|
},
|
|
3699
3708
|
{
|
|
3700
3709
|
"disabled": false,
|
|
3701
|
-
"document": "指定配额类型，包括Uid、Gid",
|
|
3710
|
+
"document": "指定配额类型，包括Uid、Gid，Dir，分别代表用户配额，用户组配额，目录配额",
|
|
3702
3711
|
"example": "Uid",
|
|
3703
3712
|
"member": "string",
|
|
3704
3713
|
"name": "UserType",
|
|
@@ -3711,12 +3720,12 @@
|
|
|
3711
3720
|
"example": "1000",
|
|
3712
3721
|
"member": "string",
|
|
3713
3722
|
"name": "UserId",
|
|
3714
|
-
"required":
|
|
3723
|
+
"required": false,
|
|
3715
3724
|
"type": "string"
|
|
3716
3725
|
},
|
|
3717
3726
|
{
|
|
3718
3727
|
"disabled": false,
|
|
3719
|
-
"document": "容量硬限制，单位GiB",
|
|
3728
|
+
"document": "容量硬限制，单位GiB。设置范围10-10000000。",
|
|
3720
3729
|
"example": "10",
|
|
3721
3730
|
"member": "uint64",
|
|
3722
3731
|
"name": "CapacityHardLimit",
|
|
@@ -3725,12 +3734,21 @@
|
|
|
3725
3734
|
},
|
|
3726
3735
|
{
|
|
3727
3736
|
"disabled": false,
|
|
3728
|
-
"document": "
|
|
3737
|
+
"document": "文件硬限制，单位个。设置范围1000-100000000",
|
|
3729
3738
|
"example": "10000",
|
|
3730
3739
|
"member": "uint64",
|
|
3731
3740
|
"name": "FileHardLimit",
|
|
3732
3741
|
"required": false,
|
|
3733
3742
|
"type": "int"
|
|
3743
|
+
},
|
|
3744
|
+
{
|
|
3745
|
+
"disabled": false,
|
|
3746
|
+
"document": "需设置目录配额的目录绝对路径，不同目录不可存在包含关系",
|
|
3747
|
+
"example": "/cfs/xx",
|
|
3748
|
+
"member": "string",
|
|
3749
|
+
"name": "DirectoryPath",
|
|
3750
|
+
"required": false,
|
|
3751
|
+
"type": "string"
|
|
3734
3752
|
}
|
|
3735
3753
|
],
|
|
3736
3754
|
"type": "object"
|
|
@@ -4720,10 +4738,11 @@
|
|
|
4720
4738
|
"members": [
|
|
4721
4739
|
{
|
|
4722
4740
|
"disabled": false,
|
|
4723
|
-
"document": "指定配额类型，包括Uid、Gid",
|
|
4741
|
+
"document": "指定配额类型，包括Uid、Gid、Dir",
|
|
4724
4742
|
"example": "Uid",
|
|
4725
4743
|
"member": "string",
|
|
4726
4744
|
"name": "UserType",
|
|
4745
|
+
"output_required": true,
|
|
4727
4746
|
"required": true,
|
|
4728
4747
|
"type": "string",
|
|
4729
4748
|
"value_allowed_null": false
|
|
@@ -4734,6 +4753,7 @@
|
|
|
4734
4753
|
"example": "1000",
|
|
4735
4754
|
"member": "string",
|
|
4736
4755
|
"name": "UserId",
|
|
4756
|
+
"output_required": true,
|
|
4737
4757
|
"required": true,
|
|
4738
4758
|
"type": "string",
|
|
4739
4759
|
"value_allowed_null": false
|
|
@@ -4744,6 +4764,7 @@
|
|
|
4744
4764
|
"example": "10",
|
|
4745
4765
|
"member": "uint64",
|
|
4746
4766
|
"name": "CapacityHardLimit",
|
|
4767
|
+
"output_required": true,
|
|
4747
4768
|
"required": true,
|
|
4748
4769
|
"type": "int",
|
|
4749
4770
|
"value_allowed_null": false
|
|
@@ -4754,6 +4775,7 @@
|
|
|
4754
4775
|
"example": "10000",
|
|
4755
4776
|
"member": "uint64",
|
|
4756
4777
|
"name": "FileHardLimit",
|
|
4778
|
+
"output_required": true,
|
|
4757
4779
|
"required": true,
|
|
4758
4780
|
"type": "int",
|
|
4759
4781
|
"value_allowed_null": false
|
|
@@ -4764,6 +4786,7 @@
|
|
|
4764
4786
|
"example": "cfs-1245",
|
|
4765
4787
|
"member": "string",
|
|
4766
4788
|
"name": "FileSystemId",
|
|
4789
|
+
"output_required": true,
|
|
4767
4790
|
"required": true,
|
|
4768
4791
|
"type": "string",
|
|
4769
4792
|
"value_allowed_null": false
|
|
@@ -4774,6 +4797,7 @@
|
|
|
4774
4797
|
"example": "9",
|
|
4775
4798
|
"member": "uint64",
|
|
4776
4799
|
"name": "CapacityUsed",
|
|
4800
|
+
"output_required": true,
|
|
4777
4801
|
"required": false,
|
|
4778
4802
|
"type": "int",
|
|
4779
4803
|
"value_allowed_null": true
|
|
@@ -4784,9 +4808,32 @@
|
|
|
4784
4808
|
"example": "9999",
|
|
4785
4809
|
"member": "uint64",
|
|
4786
4810
|
"name": "FileUsed",
|
|
4811
|
+
"output_required": true,
|
|
4787
4812
|
"required": false,
|
|
4788
4813
|
"type": "int",
|
|
4789
4814
|
"value_allowed_null": true
|
|
4815
|
+
},
|
|
4816
|
+
{
|
|
4817
|
+
"disabled": false,
|
|
4818
|
+
"document": "目录配额的目录绝对路径\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
4819
|
+
"example": "/cfs/xx",
|
|
4820
|
+
"member": "string",
|
|
4821
|
+
"name": "DirectoryPath",
|
|
4822
|
+
"output_required": true,
|
|
4823
|
+
"required": false,
|
|
4824
|
+
"type": "string",
|
|
4825
|
+
"value_allowed_null": true
|
|
4826
|
+
},
|
|
4827
|
+
{
|
|
4828
|
+
"disabled": false,
|
|
4829
|
+
"document": "配置规则状态，inavailable---配置中，available --已生效，deleting--删除中，deleted 已删除，failed--配置失败\n注意：此字段可能返回 null，表示取不到有效值。",
|
|
4830
|
+
"example": "available",
|
|
4831
|
+
"member": "string",
|
|
4832
|
+
"name": "Status",
|
|
4833
|
+
"output_required": true,
|
|
4834
|
+
"required": false,
|
|
4835
|
+
"type": "string",
|
|
4836
|
+
"value_allowed_null": true
|
|
4790
4837
|
}
|
|
4791
4838
|
],
|
|
4792
4839
|
"usage": "both"
|
|
@@ -5350,6 +5350,26 @@
|
|
|
5350
5350
|
"type": "int",
|
|
5351
5351
|
"value_allowed_null": false
|
|
5352
5352
|
},
|
|
5353
|
+
{
|
|
5354
|
+
"disabled": false,
|
|
5355
|
+
"document": "0：succeed 1：timeout",
|
|
5356
|
+
"example": "0",
|
|
5357
|
+
"member": "int64",
|
|
5358
|
+
"name": "ReturnCode",
|
|
5359
|
+
"output_required": false,
|
|
5360
|
+
"type": "int",
|
|
5361
|
+
"value_allowed_null": false
|
|
5362
|
+
},
|
|
5363
|
+
{
|
|
5364
|
+
"disabled": false,
|
|
5365
|
+
"document": "返回状态信息",
|
|
5366
|
+
"example": "success",
|
|
5367
|
+
"member": "string",
|
|
5368
|
+
"name": "ReturnMsg",
|
|
5369
|
+
"output_required": false,
|
|
5370
|
+
"type": "string",
|
|
5371
|
+
"value_allowed_null": false
|
|
5372
|
+
},
|
|
5353
5373
|
{
|
|
5354
5374
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
5355
5375
|
"member": "string",
|
|
@@ -17,14 +17,14 @@
|
|
|
17
17
|
"CreateCluster": {
|
|
18
18
|
"document": "创建EMR集群实例",
|
|
19
19
|
"input": "CreateClusterRequest",
|
|
20
|
-
"name": "创建EMR集群实例",
|
|
20
|
+
"name": "创建EMR集群实例(新)",
|
|
21
21
|
"output": "CreateClusterResponse",
|
|
22
22
|
"status": "online"
|
|
23
23
|
},
|
|
24
24
|
"CreateInstance": {
|
|
25
25
|
"document": "创建EMR集群实例",
|
|
26
26
|
"input": "CreateInstanceRequest",
|
|
27
|
-
"name": "创建EMR实例",
|
|
27
|
+
"name": "创建EMR实例(旧)",
|
|
28
28
|
"output": "CreateInstanceResponse",
|
|
29
29
|
"status": "online"
|
|
30
30
|
},
|
|
@@ -2097,6 +2097,15 @@
|
|
|
2097
2097
|
"name": "ZoneResourceConfiguration",
|
|
2098
2098
|
"required": false,
|
|
2099
2099
|
"type": "list"
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
"disabled": false,
|
|
2103
|
+
"document": "cos桶路径，创建StarRocks存算分离集群时用到",
|
|
2104
|
+
"example": "无",
|
|
2105
|
+
"member": "string",
|
|
2106
|
+
"name": "CosBucket",
|
|
2107
|
+
"required": false,
|
|
2108
|
+
"type": "string"
|
|
2100
2109
|
}
|
|
2101
2110
|
],
|
|
2102
2111
|
"type": "object"
|
|
@@ -2110,7 +2119,7 @@
|
|
|
2110
2119
|
"example": "emr-xxxxx",
|
|
2111
2120
|
"member": "string",
|
|
2112
2121
|
"name": "InstanceId",
|
|
2113
|
-
"
|
|
2122
|
+
"output_required": true,
|
|
2114
2123
|
"type": "string",
|
|
2115
2124
|
"value_allowed_null": true
|
|
2116
2125
|
},
|
|
@@ -2413,6 +2422,15 @@
|
|
|
2413
2422
|
"name": "MultiZoneSettings",
|
|
2414
2423
|
"required": false,
|
|
2415
2424
|
"type": "list"
|
|
2425
|
+
},
|
|
2426
|
+
{
|
|
2427
|
+
"disabled": false,
|
|
2428
|
+
"document": "cos桶路径，创建StarRocks存算分离集群时用到",
|
|
2429
|
+
"example": "无",
|
|
2430
|
+
"member": "string",
|
|
2431
|
+
"name": "CosBucket",
|
|
2432
|
+
"required": false,
|
|
2433
|
+
"type": "string"
|
|
2416
2434
|
}
|
|
2417
2435
|
],
|
|
2418
2436
|
"type": "object"
|
|
@@ -19,8 +19,8 @@
|
|
|
19
19
|
"CreateCluster": [
|
|
20
20
|
{
|
|
21
21
|
"document": "",
|
|
22
|
-
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCluster\n<公共请求参数>\n\n{\n \"DisasterRecoverGroupIds\": [\n \"
|
|
23
|
-
"output": "{\n \"Response\": {\n \"InstanceId\": \"
|
|
22
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCluster\n<公共请求参数>\n\n{\n \"DisasterRecoverGroupIds\": [\n \"disa\"\n ],\n \"DependService\": [\n {\n \"InstanceId\": \"emr-123\",\n \"ServiceName\": \"zookeeper\"\n }\n ],\n \"ZoneResourceConfiguration\": [\n {\n \"VirtualPrivateCloud\": {\n \"SubnetId\": \"12\",\n \"VpcId\": \"32\"\n },\n \"AllNodeResourceSpec\": {\n \"CoreResourceSpec\": {\n \"DataDisk\": [\n {\n \"Count\": 0,\n \"DiskSize\": 0,\n \"DiskType\": \"CLOUD_SSD\"\n }\n ],\n \"SystemDisk\": [\n {\n \"Count\": 0,\n \"DiskSize\": 0,\n \"DiskType\": \"CLOUD_SSD\"\n }\n ],\n \"LocalDataDisk\": [\n {\n \"Count\": 0,\n \"DiskSize\": 0,\n \"DiskType\": \"CLOUD_SSD\"\n }\n ],\n \"InstanceType\": \"S2.MEDIUM8\",\n \"Tags\": [\n {\n \"TagKey\": \"key\",\n \"TagValue\": \"value\"\n }\n ]\n },\n \"CoreCount\": 0,\n \"MasterResourceSpec\": {\n \"InstanceType\": \"S2.MEDIUM8\",\n \"Tags\": [\n {\n \"TagKey\": \"key\",\n \"TagValue\": \"value\"\n }\n ]\n },\n \"TaskCount\": 0,\n \"TaskResourceSpec\": {\n \"InstanceType\": \"S2.MEDIUM8\"\n },\n \"CommonCount\": 0,\n \"MasterCount\": 0\n },\n \"Placement\": {\n \"ProjectId\": 0,\n \"Zone\": \"GZ\"\n },\n \"ZoneTag\": \"key\"\n }\n ],\n \"ScriptBootstrapActionConfig\": [\n {\n \"CosFileName\": \"file\",\n \"Args\": [\n \"region\"\n ],\n \"CosFileURI\": \"filefads\",\n \"ExecutionMoment\": \"moment\"\n }\n ],\n \"Tags\": [\n {\n \"TagKey\": \"key\",\n \"TagValue\": \"value\"\n }\n ],\n \"NeedMasterWan\": \"127.0.0.1\",\n \"EnableCbsEncryptFlag\": true,\n \"MetaDBInfo\": {\n \"MetaDataPass\": \"pass\",\n \"MetaDataUser\": \"user\",\n \"UnifyMetaInstanceId\": \"instance\",\n \"MetaDataJdbcUrl\": \"\",\n \"MetaType\": \"\"\n },\n \"LoginSettings\": {\n \"Password\": \"\",\n \"PublicKeyId\": \"\"\n },\n \"SecurityGroupIds\": [\n \"\"\n ],\n \"InstanceChargeType\": \"\",\n \"ProductVersion\": \"\",\n \"ClientToken\": \"\",\n \"SceneSoftwareConfig\": {\n \"SceneName\": \"\",\n \"Software\": [\n \"\"\n ]\n },\n \"EnableKerberosFlag\": true,\n \"CustomConf\": \"file.xml\",\n \"InstanceChargePrepaid\": {\n \"RenewFlag\": true,\n \"Period\": 0\n },\n \"InstanceName\": \"name\",\n \"EnableRemoteLoginFlag\": true,\n \"EnableSupportHAFlag\": true\n}",
|
|
23
|
+
"output": "{\n \"Response\": {\n \"InstanceId\": \"emr-1332\",\n \"RequestId\": \"fsafa-232\"\n }\n}",
|
|
24
24
|
"title": "创建EMR集群实例"
|
|
25
25
|
}
|
|
26
26
|
],
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
"status": "online"
|
|
79
79
|
},
|
|
80
80
|
"CreateEmployeeQualificationSealQrCode": {
|
|
81
|
-
"document": "
|
|
81
|
+
"document": "该接口用于获取个人授权执业章给企业的微信二维码，需要个人用户通过微信扫码。\n\n扫描后将跳转到腾讯电子签小程序，进入到授权执业章的流程。\n\n个人用户授权成功后，企业印章管理员需对印章进行审核，审核通过后，即可使用个人授权的执业章进行盖章操作。\n\n\n**注意**\n1. 该二维码**有效期为7天**，过期后将失效，可重新创建。\n\n整体流程入下图\n\n",
|
|
82
82
|
"input": "CreateEmployeeQualificationSealQrCodeRequest",
|
|
83
83
|
"name": "创建个人印章授权给企业使用的授权二维码",
|
|
84
84
|
"output": "CreateEmployeeQualificationSealQrCodeResponse",
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
"status": "online"
|
|
100
100
|
},
|
|
101
101
|
"CreateFlowApprovers": {
|
|
102
|
-
"document": "**适用场景 ：**\n\n当通过模板或文件发起合同时， 签署人不制定， 等合同发起后再指定 可以用下面2种方案\n\n<b><font color=\"red\">1. 或签合同</font>: 若未指定企业签署人信息（只指定企业的名字），合同变成或签合同（个人签署方不支持或签合同）</b>。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下（会带有<b>或签</b>标识）：\n\n<b><font color=\"red\">2. 动态签署人合同</font>: 若未指定具体签署人的信息，则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/) 。动态签署人在控制台上的展示样式如下：\n\n\n实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序，领取合同并签署。同一签署环节可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。\n\n\n**限制条件**：\n\n1.本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。\n\n2.本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。\n\n3.他方企业仅支持通过姓名+手机号进行补充。\n\n4.个人签署人支持通过姓名+手机号进行补充（若<b>个人用户已完成实名</b>，动态签署人合同也可以可通过姓名+证件号码进行补充）\n\n\n**整体流程如下图：**\n\n",
|
|
102
|
+
"document": "**适用场景 ：**\n\n当通过模板或文件发起合同时， 签署人不制定， 等合同发起后再指定 可以用下面2种方案\n\n<b><font color=\"red\">1. 或签合同</font>: 若未指定企业签署人信息（只指定企业的名字），合同变成或签合同（个人签署方不支持或签合同）</b>。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下（会带有<b>或签</b>标识）：\n\n\n\n<b><font color=\"red\">2. 动态签署人合同</font>: 若未指定具体签署人的信息，则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档 [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/) 。动态签署人在控制台上的展示样式如下：\n\n\n\n实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序，领取合同并签署。同一签署环节可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。\n\n\n**限制条件**：\n\n1.本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。\n\n2.本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。\n\n3.他方企业仅支持通过姓名+手机号进行补充。\n\n4.个人签署人支持通过姓名+手机号进行补充（若<b>个人用户已完成实名</b>，动态签署人合同也可以可通过姓名+证件号码进行补充）\n\n\n**整体流程如下图：**\n\n",
|
|
103
103
|
"input": "CreateFlowApproversRequest",
|
|
104
104
|
"name": "补充签署流程签署人信息",
|
|
105
105
|
"output": "CreateFlowApproversResponse",
|
|
@@ -190,7 +190,7 @@
|
|
|
190
190
|
"status": "online"
|
|
191
191
|
},
|
|
192
192
|
"CreateIntegrationSubOrganizationActiveRecord": {
|
|
193
|
-
"document": "
|
|
193
|
+
"document": "使用此接口，可创建子企业激活记录。<font color=\"red\">集团企业管理员</font>可以针对尚未激活的成员企业进行激活操作。\n\n\n这个操作与页面端激活成员企业操作类似\n\n\n注意：\n1. 此接口只能用于激活，**不能用于续期**。\n2. 在激活子企业时，**请确保子企业的许可证数量充足**。",
|
|
194
194
|
"input": "CreateIntegrationSubOrganizationActiveRecordRequest",
|
|
195
195
|
"name": "创建子企业激活记录",
|
|
196
196
|
"output": "CreateIntegrationSubOrganizationActiveRecordResponse",
|
|
@@ -610,7 +610,7 @@
|
|
|
610
610
|
"status": "online"
|
|
611
611
|
},
|
|
612
612
|
"VerifyPdf": {
|
|
613
|
-
"document": "
|
|
613
|
+
"document": "对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。\n\n\n**补充**： 可以到控制台[合同验签](https://qian.tencent.com/verifySign)体验验签功能，界面如下\n",
|
|
614
614
|
"input": "VerifyPdfRequest",
|
|
615
615
|
"name": "流程文件验签",
|
|
616
616
|
"output": "VerifyPdfResponse",
|
|
@@ -2784,8 +2784,8 @@
|
|
|
2784
2784
|
},
|
|
2785
2785
|
{
|
|
2786
2786
|
"disabled": false,
|
|
2787
|
-
"document": "
|
|
2788
|
-
"example": "
|
|
2787
|
+
"document": "提示信息，扫码后此信息会展示给扫描用户，用来提示用户授权操作的目的，会在授权界面下面的位置展示。\n\n",
|
|
2788
|
+
"example": "请授权注册消防工程师执业印章",
|
|
2789
2789
|
"member": "string",
|
|
2790
2790
|
"name": "HintText",
|
|
2791
2791
|
"required": false,
|
|
@@ -248,7 +248,7 @@
|
|
|
248
248
|
{
|
|
249
249
|
"document": "企业需要员工授权执业章使用权限给企业时，调用接口产生二维码",
|
|
250
250
|
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateEmployeeQualificationSealQrCode\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n },\n \"HintText\": \"请授权执业章\"\n}",
|
|
251
|
-
"output": "{\n \"Response\": {\n \"QrcodeBase64\": \"/
|
|
251
|
+
"output": "{\n \"Response\": {\n \"QrcodeBase64\": \"/9j/2wCEAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ（剩余的其他图片base64字符串省略）\",\n \"RequestId\": \"5e94bc41-4767-4e98-943d-b9a455499847\"\n }\n}",
|
|
252
252
|
"title": "生成员工执业章授权二维码"
|
|
253
253
|
}
|
|
254
254
|
],
|
|
@@ -699,8 +699,8 @@
|
|
|
699
699
|
"CreateIntegrationSubOrganizationActiveRecord": [
|
|
700
700
|
{
|
|
701
701
|
"document": "通过此接口，创建子企业激活记录，集团企业管理员可针对未激活的成员企业进行授权。",
|
|
702
|
-
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateIntegrationSubOrganizationActiveRecord\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"
|
|
703
|
-
"output": "{\n \"Response\": {\n \"FailedSubOrganizationIds\": [],\n \"RequestId\": \"
|
|
702
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateIntegrationSubOrganizationActiveRecord\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n },\n \"SubOrganizationIds\": [\n \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\"\n ]\n}",
|
|
703
|
+
"output": "{\n \"Response\": {\n \"FailedSubOrganizationIds\": [],\n \"RequestId\": \"c858d512-c8fe-4c98-bfa4-f704947698d7\"\n }\n}",
|
|
704
704
|
"title": "创建成员企业激活记录"
|
|
705
705
|
}
|
|
706
706
|
],
|