tccli 3.0.1031.1__py2.py3-none-any.whl → 3.0.1032.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cdwdoris/v20211228/CreateInstanceNew.md +36 -0
  3. tccli/examples/cdwdoris/v20211228/DescribeClusterConfigs.md +29 -0
  4. tccli/examples/cdwdoris/v20211228/DescribeDatabaseAuditDownload.md +33 -0
  5. tccli/examples/cdwdoris/v20211228/DescribeDatabaseAuditRecords.md +47 -0
  6. tccli/examples/cdwdoris/v20211228/DescribeInstanceNodesInfo.md +54 -0
  7. tccli/examples/cdwdoris/v20211228/DescribeInstanceState.md +26 -0
  8. tccli/examples/cdwdoris/v20211228/DescribeSlowQueryRecords.md +41 -0
  9. tccli/examples/cdwdoris/v20211228/DescribeSlowQueryRecordsDownload.md +25 -0
  10. tccli/examples/cdwdoris/v20211228/DestroyInstance.md +23 -0
  11. tccli/examples/cdwdoris/v20211228/ModifyInstance.md +21 -0
  12. tccli/examples/cdwdoris/v20211228/ResizeDisk.md +25 -0
  13. tccli/examples/cdwdoris/v20211228/RestartClusterForNode.md +23 -0
  14. tccli/examples/cdwdoris/v20211228/ScaleOutInstance.md +25 -0
  15. tccli/examples/cdwdoris/v20211228/ScaleUpInstance.md +25 -0
  16. tccli/examples/essbasic/v20210526/DescribeTemplates.md +32 -4
  17. tccli/examples/mongodb/v20190725/ModifyDBInstanceSpec.md +4 -4
  18. tccli/examples/tke/v20180525/CreateClusterNodePool.md +2 -0
  19. tccli/examples/vod/v20180717/DescribeProcedureTemplates.md +3 -18
  20. tccli/examples/vod/v20180717/DescribeVodDomains.md +1 -0
  21. tccli/examples/yinsuda/v20220527/DescribeKTVMusicAccompanySegmentUrlVip.md +28 -0
  22. tccli/examples/yinsuda/v20220527/DescribeVipUserInfo.md +26 -0
  23. tccli/examples/yinsuda/v20220527/RechargeVip.md +27 -0
  24. tccli/services/cat/v20180409/api.json +10 -1
  25. tccli/services/cdwdoris/cdwdoris_client.py +750 -8
  26. tccli/services/cdwdoris/v20211228/api.json +2462 -494
  27. tccli/services/cdwdoris/v20211228/examples.json +118 -0
  28. tccli/services/cls/v20201016/api.json +2 -2
  29. tccli/services/ess/v20201111/api.json +4 -4
  30. tccli/services/essbasic/v20210526/api.json +22 -22
  31. tccli/services/essbasic/v20210526/examples.json +2 -2
  32. tccli/services/lighthouse/v20200324/api.json +5 -5
  33. tccli/services/mongodb/v20190725/api.json +11 -11
  34. tccli/services/mongodb/v20190725/examples.json +2 -2
  35. tccli/services/monitor/v20180724/api.json +2 -0
  36. tccli/services/tke/v20180525/api.json +59 -3
  37. tccli/services/tke/v20180525/examples.json +1 -1
  38. tccli/services/vod/v20180717/api.json +49 -49
  39. tccli/services/vod/v20180717/examples.json +2 -2
  40. tccli/services/vpc/v20170312/api.json +10 -0
  41. tccli/services/waf/v20180125/api.json +11 -0
  42. tccli/services/yinsuda/v20220527/api.json +305 -0
  43. tccli/services/yinsuda/v20220527/examples.json +24 -0
  44. tccli/services/yinsuda/yinsuda_client.py +175 -16
  45. {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/METADATA +2 -2
  46. {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/RECORD +49 -32
  47. {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/WHEEL +0 -0
  48. {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/entry_points.txt +0 -0
  49. {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/cdwdoris/v20211228/api.json CHANGED
@@ -1,5 +1,33 @@
1
1
  {
2
2
  "actions": {
3
+ "CreateInstanceNew": {
4
+ "document": "通过API创建集群",
5
+ "input": "CreateInstanceNewRequest",
6
+ "name": "集群创建",
7
+ "output": "CreateInstanceNewResponse",
8
+ "status": "online"
9
+ },
10
+ "DescribeClusterConfigs": {
11
+ "document": "获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户",
12
+ "input": "DescribeClusterConfigsRequest",
13
+ "name": "获取集群配置文件内容",
14
+ "output": "DescribeClusterConfigsResponse",
15
+ "status": "online"
16
+ },
17
+ "DescribeDatabaseAuditDownload": {
18
+ "document": "下载数据库审计日志",
19
+ "input": "DescribeDatabaseAuditDownloadRequest",
20
+ "name": "下载数据库审计日志",
21
+ "output": "DescribeDatabaseAuditDownloadResponse",
22
+ "status": "online"
23
+ },
24
+ "DescribeDatabaseAuditRecords": {
25
+ "document": "获取数据库审计记录",
26
+ "input": "DescribeDatabaseAuditRecordsRequest",
27
+ "name": "获取数据库审计记录",
28
+ "output": "DescribeDatabaseAuditRecordsResponse",
29
+ "status": "online"
30
+ },
3
31
  "DescribeInstance": {
4
32
  "document": "根据集群ID查询某个集群的具体信息",
5
33
  "input": "DescribeInstanceRequest",
@@ -14,12 +42,82 @@
14
42
  "output": "DescribeInstanceNodesResponse",
15
43
  "status": "online"
16
44
  },
45
+ "DescribeInstanceNodesInfo": {
46
+ "document": "获取BE/FE节点角色",
47
+ "input": "DescribeInstanceNodesInfoRequest",
48
+ "name": "获取BE、FE节点角色",
49
+ "output": "DescribeInstanceNodesInfoResponse",
50
+ "status": "online"
51
+ },
52
+ "DescribeInstanceState": {
53
+ "document": "集群详情页中显示集群状态、流程进度等",
54
+ "input": "DescribeInstanceStateRequest",
55
+ "name": "获取集群状态",
56
+ "output": "DescribeInstanceStateResponse",
57
+ "status": "online"
58
+ },
17
59
  "DescribeInstances": {
18
60
  "document": "获取集群列表",
19
61
  "input": "DescribeInstancesRequest",
20
62
  "name": "获取集群列表",
21
63
  "output": "DescribeInstancesResponse",
22
64
  "status": "online"
65
+ },
66
+ "DescribeSlowQueryRecords": {
67
+ "document": "获取慢查询列表",
68
+ "input": "DescribeSlowQueryRecordsRequest",
69
+ "name": "获取慢查询列表",
70
+ "output": "DescribeSlowQueryRecordsResponse",
71
+ "status": "online"
72
+ },
73
+ "DescribeSlowQueryRecordsDownload": {
74
+ "document": "下载慢查询文件",
75
+ "input": "DescribeSlowQueryRecordsDownloadRequest",
76
+ "name": "下载慢查询文件",
77
+ "output": "DescribeSlowQueryRecordsDownloadResponse",
78
+ "status": "online"
79
+ },
80
+ "DestroyInstance": {
81
+ "document": "销毁集群",
82
+ "input": "DestroyInstanceRequest",
83
+ "name": "集群销毁",
84
+ "output": "DestroyInstanceResponse",
85
+ "status": "online"
86
+ },
87
+ "ModifyInstance": {
88
+ "document": "修改集群名称",
89
+ "input": "ModifyInstanceRequest",
90
+ "name": "修改集群名称",
91
+ "output": "ModifyInstanceResponse",
92
+ "status": "online"
93
+ },
94
+ "ResizeDisk": {
95
+ "document": "扩容云盘",
96
+ "input": "ResizeDiskRequest",
97
+ "name": "云盘扩容",
98
+ "output": "ResizeDiskResponse",
99
+ "status": "online"
100
+ },
101
+ "RestartClusterForNode": {
102
+ "document": "集群滚动重启",
103
+ "input": "RestartClusterForNodeRequest",
104
+ "name": "集群滚动重启",
105
+ "output": "RestartClusterForNodeResponse",
106
+ "status": "online"
107
+ },
108
+ "ScaleOutInstance": {
109
+ "document": "水平扩容节点",
110
+ "input": "ScaleOutInstanceRequest",
111
+ "name": "水平扩容",
112
+ "output": "ScaleOutInstanceResponse",
113
+ "status": "online"
114
+ },
115
+ "ScaleUpInstance": {
116
+ "document": "计算资源垂直变配",
117
+ "input": "ScaleUpInstanceRequest",
118
+ "name": "计算资源垂直变配",
119
+ "output": "ScaleUpInstanceResponse",
120
+ "status": "online"
23
121
  }
24
122
  },
25
123
  "metadata": {
@@ -75,922 +173,2792 @@
75
173
  ],
76
174
  "usage": "both"
77
175
  },
78
- "DescribeInstanceNodesRequest": {
79
- "document": "DescribeInstanceNodes请求参数结构体",
176
+ "ChargeProperties": {
177
+ "document": "集群计费相关信息",
80
178
  "members": [
81
179
  {
82
180
  "disabled": false,
83
- "document": "集群实例ID",
84
- "example": "cdwch-12345678",
85
- "member": "string",
86
- "name": "InstanceId",
87
- "required": true,
88
- "type": "string"
89
- },
90
- {
91
- "disabled": false,
92
- "document": "集群角色类型，默认为 \"data\"数据节点",
93
- "example": "DATA",
181
+ "document": "计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费\n注意：此字段可能返回 null，表示取不到有效值。",
182
+ "example": "无",
94
183
  "member": "string",
95
- "name": "NodeRole",
184
+ "name": "ChargeType",
96
185
  "required": false,
97
- "type": "string"
186
+ "type": "string",
187
+ "value_allowed_null": true
98
188
  },
99
189
  {
100
190
  "disabled": false,
101
- "document": "分页参数，第一页为0，第二页为10",
102
- "example": "0",
191
+ "document": "是否自动续费，1表示自动续费开启\n注意：此字段可能返回 null，表示取不到有效值。",
192
+ "example": "无",
103
193
  "member": "int64",
104
- "name": "Offset",
194
+ "name": "RenewFlag",
105
195
  "required": false,
106
- "type": "int"
196
+ "type": "int",
197
+ "value_allowed_null": true
107
198
  },
108
199
  {
109
200
  "disabled": false,
110
- "document": "分页参数，分页步长，默认为10",
111
- "example": "100",
201
+ "document": "计费时间长度\n注意：此字段可能返回 null，表示取不到有效值。",
202
+ "example": "无",
112
203
  "member": "int64",
113
- "name": "Limit",
204
+ "name": "TimeSpan",
114
205
  "required": false,
115
- "type": "int"
206
+ "type": "int",
207
+ "value_allowed_null": true
116
208
  },
117
209
  {
118
210
  "disabled": false,
119
- "document": "展现策略，All时显示所有",
120
- "example": "All",
211
+ "document": "计费时间单位，“m”表示月等\n注意：此字段可能返回 null，表示取不到有效值。",
212
+ "example": "无",
121
213
  "member": "string",
122
- "name": "DisplayPolicy",
214
+ "name": "TimeUnit",
123
215
  "required": false,
124
- "type": "string"
216
+ "type": "string",
217
+ "value_allowed_null": true
125
218
  }
126
219
  ],
127
- "type": "object"
220
+ "usage": "both"
128
221
  },
129
- "DescribeInstanceNodesResponse": {
130
- "document": "DescribeInstanceNodes返回参数结构体",
222
+ "ClusterConfigsInfoFromEMR": {
223
+ "document": "用于返回XML格式的配置文件和内容以及其他配置文件有关的信息",
131
224
  "members": [
132
225
  {
133
226
  "disabled": false,
134
- "document": "总数",
135
- "example": "2",
136
- "member": "int64",
137
- "name": "TotalCount",
227
+ "document": "配置文件名称",
228
+ "example": "config.xml",
229
+ "member": "string",
230
+ "name": "FileName",
138
231
  "output_required": true,
139
- "type": "int",
232
+ "type": "string",
140
233
  "value_allowed_null": false
141
234
  },
142
235
  {
143
236
  "disabled": false,
144
- "document": "实例节点总数\n注意：此字段可能返回 null，表示取不到有效值。",
145
- "example": "无",
146
- "member": "InstanceNode",
147
- "name": "InstanceNodesList",
237
+ "document": "配置文件对应的相关属性信息",
238
+ "example": "{\"editable\":true,\"display\":true,\"type\":\"Customize\",\"fileOwner\":\"",
239
+ "member": "string",
240
+ "name": "FileConf",
148
241
  "output_required": true,
149
- "type": "list",
150
- "value_allowed_null": true
242
+ "type": "string",
243
+ "value_allowed_null": false
151
244
  },
152
245
  {
153
- "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
246
+ "disabled": false,
247
+ "document": "配置文件对应的其他属性信息",
248
+ "example": "{\"customKey\":{\"name\":\"customKey\",\"type\":\"string\",\"description\":\"",
154
249
  "member": "string",
155
- "name": "RequestId",
156
- "type": "string"
157
- }
158
- ],
159
- "type": "object"
160
- },
161
- "DescribeInstanceRequest": {
162
- "document": "DescribeInstance请求参数结构体",
163
- "members": [
250
+ "name": "KeyConf",
251
+ "output_required": true,
252
+ "type": "string",
253
+ "value_allowed_null": false
254
+ },
164
255
  {
165
256
  "disabled": false,
166
- "document": "集群实例ID",
167
- "example": "cdwch-12345678",
257
+ "document": "配置文件的内容，base64编码",
258
+ "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K",
168
259
  "member": "string",
169
- "name": "InstanceId",
170
- "required": true,
171
- "type": "string"
172
- }
173
- ],
174
- "type": "object"
175
- },
176
- "DescribeInstanceResponse": {
177
- "document": "DescribeInstance返回参数结构体",
178
- "members": [
260
+ "name": "OriParam",
261
+ "output_required": true,
262
+ "type": "string",
263
+ "value_allowed_null": false
264
+ },
179
265
  {
180
266
  "disabled": false,
181
- "document": "实例描述信息",
182
- "example": "无",
183
- "member": "InstanceInfo",
184
- "name": "InstanceInfo",
267
+ "document": "用于表示当前配置文件是不是有过修改后没有重启，提醒用户需要重启",
268
+ "example": "1",
269
+ "member": "int64",
270
+ "name": "NeedRestart",
185
271
  "output_required": true,
186
- "type": "object",
272
+ "type": "int",
187
273
  "value_allowed_null": false
188
274
  },
189
275
  {
190
- "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
276
+ "disabled": false,
277
+ "document": "配置文件路径\n注意：此字段可能返回 null，表示取不到有效值。",
278
+ "example": ":\"/usr/local/service/doris/conf\"",
191
279
  "member": "string",
192
- "name": "RequestId",
193
- "type": "string"
280
+ "name": "FilePath",
281
+ "output_required": false,
282
+ "type": "string",
283
+ "value_allowed_null": true
284
+ },
285
+ {
286
+ "disabled": true,
287
+ "document": "配置文件kv值\n注意：此字段可能返回 null，表示取不到有效值。",
288
+ "example": "[{\"KeyName\":\"broker_ipc_port\",\"Value\":\"8000\",\"Message\":\"内部通信端口\",\"Display\":1,\"SupportHotUpdate\":0},{\"KeyName\":\"client_expire_seconds\",\"Value\":\"300\",\"Message\":\"客户端过期时间\",\"Display\":1,\"SupportHotUpdate\":0},{\"KeyName\":\"XMX\",\"Value\":\"3g\",\"Message\":\"最大Heap的大小\",\"Display\":2,\"SupportHotUpdate\":0}]}]",
289
+ "member": "string",
290
+ "name": "FileKeyValues",
291
+ "output_required": false,
292
+ "type": "string",
293
+ "value_allowed_null": true
294
+ },
295
+ {
296
+ "disabled": false,
297
+ "document": "配置文件kv值\n注意：此字段可能返回 null，表示取不到有效值。",
298
+ "example": "无",
299
+ "member": "ConfigKeyValue",
300
+ "name": "FileKeyValuesNew",
301
+ "output_required": false,
302
+ "type": "list",
303
+ "value_allowed_null": true
194
304
  }
195
305
  ],
196
- "type": "object"
306
+ "usage": "out"
197
307
  },
198
- "DescribeInstancesRequest": {
199
- "document": "DescribeInstances请求参数结构体",
308
+ "ConfigKeyValue": {
309
+ "document": "返回配置的文件内容（key-value）",
200
310
  "members": [
201
311
  {
202
312
  "disabled": false,
203
- "document": "搜索的集群id名称",
204
- "example": "cdwch-xxxx",
313
+ "document": "key\n注意：此字段可能返回 null，表示取不到有效值。",
314
+ "example": "无",
205
315
  "member": "string",
206
- "name": "SearchInstanceId",
207
- "required": false,
208
- "type": "string"
316
+ "name": "KeyName",
317
+ "output_required": false,
318
+ "type": "string",
319
+ "value_allowed_null": true
209
320
  },
210
321
  {
211
322
  "disabled": false,
212
- "document": "搜索的集群name",
213
- "example": "-",
323
+ "document": "值\n注意：此字段可能返回 null，表示取不到有效值。",
324
+ "example": "无",
214
325
  "member": "string",
215
- "name": "SearchInstanceName",
216
- "required": false,
217
- "type": "string"
326
+ "name": "Value",
327
+ "output_required": false,
328
+ "type": "string",
329
+ "value_allowed_null": true
218
330
  },
219
331
  {
220
332
  "disabled": false,
221
- "document": "分页参数，第一页为0，第二页为10",
222
- "example": "0",
223
- "member": "int64",
224
- "name": "Offset",
225
- "required": false,
226
- "type": "int"
333
+ "document": "备注\n注意：此字段可能返回 null，表示取不到有效值。",
334
+ "example": "无",
335
+ "member": "string",
336
+ "name": "Message",
337
+ "output_required": false,
338
+ "type": "string",
339
+ "value_allowed_null": true
227
340
  },
228
341
  {
229
342
  "disabled": false,
230
- "document": "分页参数，分页步长，默认为10",
231
- "example": "20",
343
+ "document": "1-只读，2-可修改但不可删除，3-可删除\n注意：此字段可能返回 null，表示取不到有效值。",
344
+ "example": "无",
232
345
  "member": "int64",
233
- "name": "Limit",
234
- "required": false,
235
- "type": "int"
346
+ "name": "Display",
347
+ "output_required": false,
348
+ "type": "int",
349
+ "value_allowed_null": true
236
350
  },
237
351
  {
238
352
  "disabled": false,
239
- "document": "搜索标签列表",
353
+ "document": "0不支持 1支持热更新\n注意：此字段可能返回 null，表示取不到有效值。",
240
354
  "example": "无",
241
- "member": "SearchTags",
242
- "name": "SearchTags",
243
- "required": false,
244
- "type": "list"
355
+ "member": "int64",
356
+ "name": "SupportHotUpdate",
357
+ "output_required": false,
358
+ "type": "int",
359
+ "value_allowed_null": true
245
360
  }
246
361
  ],
247
- "type": "object"
362
+ "usage": "out"
248
363
  },
249
- "DescribeInstancesResponse": {
250
- "document": "DescribeInstances返回参数结构体",
364
+ "CreateInstanceNewRequest": {
365
+ "document": "CreateInstanceNew请求参数结构体",
251
366
  "members": [
252
367
  {
253
368
  "disabled": false,
254
- "document": "实例总数",
255
- "example": "18",
256
- "member": "int64",
257
- "name": "TotalCount",
258
- "output_required": true,
259
- "type": "int",
260
- "value_allowed_null": false
369
+ "document": "可用区",
370
+ "example": "无",
371
+ "member": "string",
372
+ "name": "Zone",
373
+ "required": true,
374
+ "type": "string"
261
375
  },
262
376
  {
263
377
  "disabled": false,
264
- "document": "实例数组",
265
- "example": "-",
266
- "member": "InstanceInfo",
267
- "name": "InstancesList",
268
- "output_required": true,
269
- "type": "list",
270
- "value_allowed_null": false
378
+ "document": "FE规格",
379
+ "example": "无",
380
+ "member": "CreateInstanceSpec",
381
+ "name": "FeSpec",
382
+ "required": true,
383
+ "type": "object"
271
384
  },
272
- {
273
- "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
274
- "member": "string",
275
- "name": "RequestId",
276
- "type": "string"
277
- }
278
- ],
279
- "type": "object"
280
- },
281
- "InstanceInfo": {
282
- "document": "实例描述信息",
283
- "members": [
284
385
  {
285
386
  "disabled": false,
286
- "document": "集群实例ID, \"cdw-xxxx\" 字符串类型\n注意：此字段可能返回 null，表示取不到有效值。",
287
- "example": "cdwch-xxxxxxxx",
288
- "member": "string",
289
- "name": "InstanceId",
290
- "output_required": true,
291
- "type": "string",
292
- "value_allowed_null": true
387
+ "document": "BE规格",
388
+ "example": "无",
389
+ "member": "CreateInstanceSpec",
390
+ "name": "BeSpec",
391
+ "required": true,
392
+ "type": "object"
293
393
  },
294
394
  {
295
395
  "disabled": false,
296
- "document": "集群实例名称\n注意：此字段可能返回 null，表示取不到有效值。",
297
- "example": "clickhouse集群",
298
- "member": "string",
299
- "name": "InstanceName",
300
- "output_required": true,
301
- "type": "string",
302
- "value_allowed_null": true
396
+ "document": "是否高可用",
397
+ "example": "无",
398
+ "member": "bool",
399
+ "name": "HaFlag",
400
+ "required": true,
401
+ "type": "bool"
303
402
  },
304
403
  {
305
404
  "disabled": false,
306
- "document": "状态,\nInit 创建中; Serving 运行中； \nDeleted已销毁；Deleting 销毁中；\nModify 集群变更中；\n注意：此字段可能返回 null，表示取不到有效值。",
307
- "example": "Running",
405
+ "document": "用户VPCID",
406
+ "example": "无",
308
407
  "member": "string",
309
- "name": "Status",
310
- "output_required": true,
311
- "type": "string",
312
- "value_allowed_null": true
408
+ "name": "UserVPCId",
409
+ "required": true,
410
+ "type": "string"
313
411
  },
314
412
  {
315
413
  "disabled": false,
316
- "document": "版本\n注意：此字段可能返回 null，表示取不到有效值。",
317
- "example": "20.7.2.30",
414
+ "document": "用户子网ID",
415
+ "example": "无",
318
416
  "member": "string",
319
- "name": "Version",
320
- "output_required": true,
321
- "type": "string",
322
- "value_allowed_null": true
417
+ "name": "UserSubnetId",
418
+ "required": true,
419
+ "type": "string"
323
420
  },
324
421
  {
325
422
  "disabled": false,
326
- "document": "地域, ap-guangzhou\n注意：此字段可能返回 null，表示取不到有效值。",
327
- "example": "ap-guangzhou",
423
+ "document": "产品版本号",
424
+ "example": "无",
328
425
  "member": "string",
329
- "name": "Region",
330
- "output_required": true,
331
- "type": "string",
332
- "value_allowed_null": true
426
+ "name": "ProductVersion",
427
+ "required": true,
428
+ "type": "string"
333
429
  },
334
430
  {
335
431
  "disabled": false,
336
- "document": "可用区， ap-guangzhou-3\n注意：此字段可能返回 null，表示取不到有效值。",
337
- "example": "ap-guangzhou-3",
338
- "member": "string",
339
- "name": "Zone",
340
- "output_required": true,
341
- "type": "string",
342
- "value_allowed_null": true
432
+ "document": "付费类型",
433
+ "example": "无",
434
+ "member": "ChargeProperties",
435
+ "name": "ChargeProperties",
436
+ "required": true,
437
+ "type": "object"
343
438
  },
344
439
  {
345
440
  "disabled": false,
346
- "document": "私有网络名称\n注意：此字段可能返回 null，表示取不到有效值。",
347
- "example": "vpc-xxxxxx",
441
+ "document": "实例名字",
442
+ "example": "无",
348
443
  "member": "string",
349
- "name": "VpcId",
350
- "output_required": true,
351
- "type": "string",
352
- "value_allowed_null": true
444
+ "name": "InstanceName",
445
+ "required": true,
446
+ "type": "string"
353
447
  },
354
448
  {
355
449
  "disabled": false,
356
- "document": "子网名称\n注意：此字段可能返回 null，表示取不到有效值。",
357
- "example": "subnet-xxxxx",
450
+ "document": "数据库密码",
451
+ "example": "无",
358
452
  "member": "string",
359
- "name": "SubnetId",
360
- "output_required": true,
361
- "type": "string",
362
- "value_allowed_null": true
453
+ "name": "DorisUserPwd",
454
+ "required": true,
455
+ "type": "string"
363
456
  },
364
457
  {
365
458
  "disabled": false,
366
- "document": "付费类型，\"hour\", \"prepay\"\n注意：此字段可能返回 null，表示取不到有效值。",
367
- "example": "hour",
368
- "member": "string",
369
- "name": "PayMode",
370
- "output_required": true,
371
- "type": "string",
372
- "value_allowed_null": true
459
+ "document": "标签列表",
460
+ "example": "无",
461
+ "member": "Tag",
462
+ "name": "Tags",
463
+ "required": false,
464
+ "type": "list"
373
465
  },
374
466
  {
375
467
  "disabled": false,
376
- "document": "创建时间\n注意：此字段可能返回 null，表示取不到有效值。",
377
- "example": "2020-01-01 11:11:11",
378
- "member": "string",
379
- "name": "CreateTime",
380
- "output_required": true,
381
- "type": "string",
382
- "value_allowed_null": true
468
+ "document": "高可用类型：0：非高可用，1：读高可用，2：读写高可用。",
469
+ "example": "0",
470
+ "member": "int64",
471
+ "name": "HaType",
472
+ "required": false,
473
+ "type": "int"
383
474
  },
384
475
  {
385
476
  "disabled": false,
386
- "document": "过期时间\n注意：此字段可能返回 null，表示取不到有效值。",
387
- "example": "2020-02-01 11:11:11",
388
- "member": "string",
389
- "name": "ExpireTime",
390
- "output_required": true,
391
- "type": "string",
392
- "value_allowed_null": true
393
- },
477
+ "document": "表名大小写是否敏感，0：敏感；1：不敏感，以小写进行比较；2：不敏感，表名改为以小写存储",
478
+ "example": "0",
479
+ "member": "int64",
480
+ "name": "CaseSensitive",
481
+ "required": false,
482
+ "type": "int"
483
+ }
484
+ ],
485
+ "type": "object"
486
+ },
487
+ "CreateInstanceNewResponse": {
488
+ "document": "CreateInstanceNew返回参数结构体",
489
+ "members": [
394
490
  {
395
491
  "disabled": false,
396
- "document": "数据节点描述信息\n注意：此字段可能返回 null，表示取不到有效值。",
492
+ "document": "流程ID",
397
493
  "example": "无",
398
- "member": "NodesSummary",
399
- "name": "MasterSummary",
494
+ "member": "string",
495
+ "name": "FlowId",
400
496
  "output_required": false,
401
- "type": "object",
402
- "value_allowed_null": true
497
+ "type": "string",
498
+ "value_allowed_null": false
403
499
  },
404
500
  {
405
501
  "disabled": false,
406
- "document": "zookeeper节点描述信息\n注意：此字段可能返回 null，表示取不到有效值。",
502
+ "document": "实例ID",
407
503
  "example": "无",
408
- "member": "NodesSummary",
409
- "name": "CoreSummary",
504
+ "member": "string",
505
+ "name": "InstanceId",
410
506
  "output_required": false,
411
- "type": "object",
412
- "value_allowed_null": true
507
+ "type": "string",
508
+ "value_allowed_null": false
413
509
  },
414
510
  {
415
511
  "disabled": false,
416
- "document": "高可用，“true\" \"false\"\n注意：此字段可能返回 null，表示取不到有效值。",
417
- "example": "false",
512
+ "document": "错误信息",
513
+ "example": "无",
418
514
  "member": "string",
419
- "name": "HA",
420
- "output_required": true,
515
+ "name": "ErrorMsg",
516
+ "output_required": false,
421
517
  "type": "string",
422
- "value_allowed_null": true
518
+ "value_allowed_null": false
423
519
  },
424
520
  {
425
- "disabled": false,
426
- "document": "高可用类型：\n0：非高可用\n1：读高可用\n2：读写高可用。\n注意：此字段可能返回 null，表示取不到有效值。",
427
- "example": "1",
428
- "member": "int64",
429
- "name": "HaType",
430
- "output_required": false,
431
- "type": "int",
432
- "value_allowed_null": true
433
- },
521
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
522
+ "member": "string",
523
+ "name": "RequestId",
524
+ "type": "string"
525
+ }
526
+ ],
527
+ "type": "object"
528
+ },
529
+ "CreateInstanceSpec": {
530
+ "document": "集群规格",
531
+ "members": [
434
532
  {
435
533
  "disabled": false,
436
- "document": "访问地址，例如 \"10.0.0.1:9000\"\n注意：此字段可能返回 null，表示取不到有效值。",
437
- "example": "\"10.0.0.1:9000\"",
534
+ "document": "规格名字",
535
+ "example": "无",
438
536
  "member": "string",
439
- "name": "AccessInfo",
440
- "output_required": true,
441
- "type": "string",
442
- "value_allowed_null": true
537
+ "name": "SpecName",
538
+ "required": true,
539
+ "type": "string"
443
540
  },
444
541
  {
445
542
  "disabled": false,
446
- "document": "记录ID，数值型\n注意：此字段可能返回 null，表示取不到有效值。",
447
- "example": "1",
448
- "member": "int64",
449
- "name": "Id",
450
- "output_required": true,
451
- "type": "int",
452
- "value_allowed_null": true
543
+ "document": "数量",
544
+ "example": "无",
545
+ "member": "uint64",
546
+ "name": "Count",
547
+ "required": true,
548
+ "type": "int"
453
549
  },
454
550
  {
455
551
  "disabled": false,
456
- "document": "regionId, 表示地域\n注意：此字段可能返回 null，表示取不到有效值。",
457
- "example": "1",
458
- "member": "int64",
459
- "name": "RegionId",
552
+ "document": "云盘大小",
553
+ "example": "无",
554
+ "member": "uint64",
555
+ "name": "DiskSize",
556
+ "required": true,
557
+ "type": "int"
558
+ }
559
+ ],
560
+ "usage": "in"
561
+ },
562
+ "DataBaseAuditRecord": {
563
+ "document": "数据库审计",
564
+ "members": [
565
+ {
566
+ "disabled": false,
567
+ "document": "查询用户\n注意：此字段可能返回 null，表示取不到有效值。",
568
+ "example": "xx",
569
+ "member": "string",
570
+ "name": "OsUser",
460
571
  "output_required": true,
461
- "type": "int",
572
+ "type": "string",
462
573
  "value_allowed_null": true
463
574
  },
464
575
  {
465
576
  "disabled": false,
466
- "document": "可用区说明，例如 \"广州二区\"\n注意：此字段可能返回 null，表示取不到有效值。",
467
- "example": "广州三区",
577
+ "document": "查询ID\n注意：此字段可能返回 null，表示取不到有效值。",
578
+ "example": "xx",
468
579
  "member": "string",
469
- "name": "ZoneDesc",
580
+ "name": "InitialQueryId",
470
581
  "output_required": true,
471
582
  "type": "string",
472
583
  "value_allowed_null": true
473
584
  },
474
585
  {
475
586
  "disabled": false,
476
- "document": "错误流程说明信息\n注意：此字段可能返回 null，表示取不到有效值。",
477
- "example": "\"\"",
587
+ "document": "SQL语句\n注意：此字段可能返回 null，表示取不到有效值。",
588
+ "example": "xx",
478
589
  "member": "string",
479
- "name": "FlowMsg",
590
+ "name": "Sql",
480
591
  "output_required": true,
481
592
  "type": "string",
482
593
  "value_allowed_null": true
483
594
  },
484
595
  {
485
596
  "disabled": false,
486
- "document": "状态描述，例如“运行中”等\n注意：此字段可能返回 null，表示取不到有效值。",
487
- "example": "运行中",
597
+ "document": "开始时间\n注意：此字段可能返回 null，表示取不到有效值。",
598
+ "example": "xx",
488
599
  "member": "string",
489
- "name": "StatusDesc",
600
+ "name": "QueryStartTime",
490
601
  "output_required": true,
491
602
  "type": "string",
492
603
  "value_allowed_null": true
493
604
  },
494
605
  {
495
606
  "disabled": false,
496
- "document": "自动续费标记\n注意：此字段可能返回 null，表示取不到有效值。",
497
- "example": "false",
498
- "member": "bool",
499
- "name": "RenewFlag",
607
+ "document": "执行耗时\n注意：此字段可能返回 null，表示取不到有效值。",
608
+ "example": "xx",
609
+ "member": "int64",
610
+ "name": "DurationMs",
500
611
  "output_required": true,
501
- "type": "bool",
612
+ "type": "int",
502
613
  "value_allowed_null": true
503
614
  },
504
615
  {
505
616
  "disabled": false,
506
- "document": "标签列表\n注意：此字段可能返回 null，表示取不到有效值。",
507
- "example": "无",
508
- "member": "Tag",
509
- "name": "Tags",
617
+ "document": "读取行数\n注意：此字段可能返回 null，表示取不到有效值。",
618
+ "example": "xx",
619
+ "member": "int64",
620
+ "name": "ReadRows",
510
621
  "output_required": true,
511
- "type": "list",
622
+ "type": "int",
512
623
  "value_allowed_null": true
513
624
  },
514
625
  {
515
626
  "disabled": false,
516
- "document": "监控信息\n注意：此字段可能返回 null，表示取不到有效值。",
517
- "example": "prom-aaaaa",
518
- "member": "string",
519
- "name": "Monitor",
627
+ "document": "读取字节数\n注意：此字段可能返回 null，表示取不到有效值。",
628
+ "example": "xx",
629
+ "member": "int64",
630
+ "name": "ResultRows",
520
631
  "output_required": true,
521
- "type": "string",
632
+ "type": "int",
522
633
  "value_allowed_null": true
523
634
  },
524
635
  {
525
636
  "disabled": false,
526
- "document": "是否开通日志\n注意：此字段可能返回 null，表示取不到有效值。",
527
- "example": "true",
528
- "member": "bool",
529
- "name": "HasClsTopic",
637
+ "document": "结果字节数\n注意：此字段可能返回 null，表示取不到有效值。",
638
+ "example": "xx",
639
+ "member": "uint64",
640
+ "name": "ResultBytes",
530
641
  "output_required": true,
531
- "type": "bool",
642
+ "type": "int",
532
643
  "value_allowed_null": true
533
644
  },
534
645
  {
535
646
  "disabled": false,
536
- "document": "日志主题ID\n注意：此字段可能返回 null，表示取不到有效值。",
537
- "example": "xxx",
538
- "member": "string",
539
- "name": "ClsTopicId",
647
+ "document": "内存\n注意：此字段可能返回 null，表示取不到有效值。",
648
+ "example": "xx",
649
+ "member": "int64",
650
+ "name": "MemoryUsage",
540
651
  "output_required": true,
541
- "type": "string",
652
+ "type": "int",
542
653
  "value_allowed_null": true
543
654
  },
544
655
  {
545
656
  "disabled": false,
546
- "document": "日志集ID\n注意：此字段可能返回 null，表示取不到有效值。",
547
- "example": "xxx",
657
+ "document": "初始查询IP\n注意：此字段可能返回 null，表示取不到有效值。",
658
+ "example": "xx",
548
659
  "member": "string",
549
- "name": "ClsLogSetId",
660
+ "name": "InitialAddress",
550
661
  "output_required": true,
551
662
  "type": "string",
552
663
  "value_allowed_null": true
553
664
  },
554
665
  {
555
666
  "disabled": false,
556
- "document": "是否支持xml配置管理\n注意：此字段可能返回 null，表示取不到有效值。",
557
- "example": "1",
558
- "member": "int64",
559
- "name": "EnableXMLConfig",
667
+ "document": "数据库\n注意：此字段可能返回 null，表示取不到有效值。",
668
+ "example": "xx",
669
+ "member": "string",
670
+ "name": "DbName",
560
671
  "output_required": true,
561
- "type": "int",
672
+ "type": "string",
562
673
  "value_allowed_null": true
563
674
  },
564
675
  {
565
676
  "disabled": false,
566
- "document": "区域\n注意：此字段可能返回 null，表示取不到有效值。",
567
- "example": "广州",
677
+ "document": "sql类型\n注意：此字段可能返回 null，表示取不到有效值。",
678
+ "example": "xx",
568
679
  "member": "string",
569
- "name": "RegionDesc",
680
+ "name": "SqlType",
570
681
  "output_required": true,
571
682
  "type": "string",
572
683
  "value_allowed_null": true
573
684
  },
574
685
  {
575
686
  "disabled": false,
576
- "document": "弹性网卡地址\n注意：此字段可能返回 null，表示取不到有效值。",
577
- "example": "127.0.0.1",
687
+ "document": "catalog名称\n注意：此字段可能返回 null，表示取不到有效值。",
688
+ "example": "xxx",
578
689
  "member": "string",
579
- "name": "Eip",
580
- "output_required": true,
690
+ "name": "Catalog",
691
+ "output_required": false,
581
692
  "type": "string",
582
693
  "value_allowed_null": true
583
- },
694
+ }
695
+ ],
696
+ "usage": "out"
697
+ },
698
+ "DescribeClusterConfigsRequest": {
699
+ "document": "DescribeClusterConfigs请求参数结构体",
700
+ "members": [
701
+ {
702
+ "disabled": false,
703
+ "document": "集群实例ID",
704
+ "example": "cdwch-f625kxu6",
705
+ "member": "string",
706
+ "name": "InstanceId",
707
+ "required": true,
708
+ "type": "string"
709
+ },
710
+ {
711
+ "disabled": false,
712
+ "document": " 0 公有云查询；1青鹅查询，青鹅查询显示所有需要展示的",
713
+ "example": "1",
714
+ "member": "int64",
715
+ "name": "ConfigType",
716
+ "required": false,
717
+ "type": "int"
718
+ },
719
+ {
720
+ "disabled": false,
721
+ "document": "模糊搜索关键字文件",
722
+ "example": "Keytab",
723
+ "member": "string",
724
+ "name": "FileName",
725
+ "required": false,
726
+ "type": "string"
727
+ },
728
+ {
729
+ "disabled": false,
730
+ "document": "0集群维度 1节点维度",
731
+ "example": "0",
732
+ "member": "int64",
733
+ "name": "ClusterConfigType",
734
+ "required": false,
735
+ "type": "int"
736
+ },
737
+ {
738
+ "disabled": false,
739
+ "document": "eth0的ip地址",
740
+ "example": "127.0.0.1",
741
+ "member": "string",
742
+ "name": "IPAddress",
743
+ "required": false,
744
+ "type": "string"
745
+ }
746
+ ],
747
+ "type": "object"
748
+ },
749
+ "DescribeClusterConfigsResponse": {
750
+ "document": "DescribeClusterConfigs返回参数结构体",
751
+ "members": [
752
+ {
753
+ "disabled": false,
754
+ "document": "返回实例的配置文件相关的信息",
755
+ "example": "无",
756
+ "member": "ClusterConfigsInfoFromEMR",
757
+ "name": "ClusterConfList",
758
+ "output_required": true,
759
+ "type": "list",
760
+ "value_allowed_null": false
761
+ },
762
+ {
763
+ "disabled": false,
764
+ "document": "返回当前内核版本 如果不存在则返回空字符串",
765
+ "example": "无",
766
+ "member": "string",
767
+ "name": "BuildVersion",
768
+ "output_required": false,
769
+ "type": "string",
770
+ "value_allowed_null": false
771
+ },
772
+ {
773
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
774
+ "member": "string",
775
+ "name": "RequestId",
776
+ "type": "string"
777
+ }
778
+ ],
779
+ "type": "object"
780
+ },
781
+ "DescribeDatabaseAuditDownloadRequest": {
782
+ "document": "DescribeDatabaseAuditDownload请求参数结构体",
783
+ "members": [
784
+ {
785
+ "disabled": false,
786
+ "document": "实例ID",
787
+ "example": "xx",
788
+ "member": "string",
789
+ "name": "InstanceId",
790
+ "required": true,
791
+ "type": "string"
792
+ },
793
+ {
794
+ "disabled": false,
795
+ "document": "开始时间",
796
+ "example": "xx",
797
+ "member": "string",
798
+ "name": "StartTime",
799
+ "required": true,
800
+ "type": "string"
801
+ },
802
+ {
803
+ "disabled": false,
804
+ "document": "结束时间",
805
+ "example": "xx",
806
+ "member": "string",
807
+ "name": "EndTime",
808
+ "required": true,
809
+ "type": "string"
810
+ },
811
+ {
812
+ "disabled": false,
813
+ "document": "分页",
814
+ "example": "1",
815
+ "member": "int64",
816
+ "name": "PageSize",
817
+ "required": true,
818
+ "type": "int"
819
+ },
820
+ {
821
+ "disabled": false,
822
+ "document": "分页",
823
+ "example": "10",
824
+ "member": "int64",
825
+ "name": "PageNum",
826
+ "required": true,
827
+ "type": "int"
828
+ },
829
+ {
830
+ "disabled": false,
831
+ "document": "排序参数",
832
+ "example": "DESC/ASC",
833
+ "member": "string",
834
+ "name": "OrderType",
835
+ "required": false,
836
+ "type": "string"
837
+ },
838
+ {
839
+ "disabled": false,
840
+ "document": "用户",
841
+ "example": "无",
842
+ "member": "string",
843
+ "name": "User",
844
+ "required": false,
845
+ "type": "string"
846
+ },
847
+ {
848
+ "disabled": false,
849
+ "document": "数据库",
850
+ "example": "无",
851
+ "member": "string",
852
+ "name": "DbName",
853
+ "required": false,
854
+ "type": "string"
855
+ },
856
+ {
857
+ "disabled": false,
858
+ "document": "sql类型",
859
+ "example": "无",
860
+ "member": "string",
861
+ "name": "SqlType",
862
+ "required": false,
863
+ "type": "string"
864
+ },
865
+ {
866
+ "disabled": false,
867
+ "document": "sql语句",
868
+ "example": "sql",
869
+ "member": "string",
870
+ "name": "Sql",
871
+ "required": false,
872
+ "type": "string"
873
+ },
874
+ {
875
+ "disabled": false,
876
+ "document": "用户 多选",
877
+ "example": "无",
878
+ "member": "string",
879
+ "name": "Users",
880
+ "required": false,
881
+ "type": "list"
882
+ },
883
+ {
884
+ "disabled": false,
885
+ "document": "数据库 多选",
886
+ "example": "无",
887
+ "member": "string",
888
+ "name": "DbNames",
889
+ "required": false,
890
+ "type": "list"
891
+ },
892
+ {
893
+ "disabled": false,
894
+ "document": "sql类型 多选",
895
+ "example": "无",
896
+ "member": "string",
897
+ "name": "SqlTypes",
898
+ "required": false,
899
+ "type": "list"
900
+ },
901
+ {
902
+ "disabled": false,
903
+ "document": "catalog名称 （多选）",
904
+ "example": "无",
905
+ "member": "string",
906
+ "name": "Catalogs",
907
+ "required": false,
908
+ "type": "list"
909
+ }
910
+ ],
911
+ "type": "object"
912
+ },
913
+ "DescribeDatabaseAuditDownloadResponse": {
914
+ "document": "DescribeDatabaseAuditDownload返回参数结构体",
915
+ "members": [
916
+ {
917
+ "disabled": false,
918
+ "document": "日志的cos地址",
919
+ "example": "xx",
920
+ "member": "string",
921
+ "name": "CosUrl",
922
+ "output_required": true,
923
+ "type": "string",
924
+ "value_allowed_null": false
925
+ },
926
+ {
927
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
928
+ "member": "string",
929
+ "name": "RequestId",
930
+ "type": "string"
931
+ }
932
+ ],
933
+ "type": "object"
934
+ },
935
+ "DescribeDatabaseAuditRecordsRequest": {
936
+ "document": "DescribeDatabaseAuditRecords请求参数结构体",
937
+ "members": [
938
+ {
939
+ "disabled": false,
940
+ "document": "实例ID",
941
+ "example": "xx",
942
+ "member": "string",
943
+ "name": "InstanceId",
944
+ "required": true,
945
+ "type": "string"
946
+ },
947
+ {
948
+ "disabled": false,
949
+ "document": "开始时间",
950
+ "example": "xx",
951
+ "member": "string",
952
+ "name": "StartTime",
953
+ "required": true,
954
+ "type": "string"
955
+ },
956
+ {
957
+ "disabled": false,
958
+ "document": "结束时间",
959
+ "example": "xx",
960
+ "member": "string",
961
+ "name": "EndTime",
962
+ "required": true,
963
+ "type": "string"
964
+ },
965
+ {
966
+ "disabled": false,
967
+ "document": "分页",
968
+ "example": "xx",
969
+ "member": "int64",
970
+ "name": "PageSize",
971
+ "required": true,
972
+ "type": "int"
973
+ },
974
+ {
975
+ "disabled": false,
976
+ "document": "分页",
977
+ "example": "xx",
978
+ "member": "int64",
979
+ "name": "PageNum",
980
+ "required": true,
981
+ "type": "int"
982
+ },
983
+ {
984
+ "disabled": false,
985
+ "document": "排序参数",
986
+ "example": "DESC/ASC",
987
+ "member": "string",
988
+ "name": "OrderType",
989
+ "required": false,
990
+ "type": "string"
991
+ },
992
+ {
993
+ "disabled": false,
994
+ "document": "用户",
995
+ "example": "无",
996
+ "member": "string",
997
+ "name": "User",
998
+ "required": false,
999
+ "type": "string"
1000
+ },
1001
+ {
1002
+ "disabled": false,
1003
+ "document": "数据库",
1004
+ "example": "无",
1005
+ "member": "string",
1006
+ "name": "DbName",
1007
+ "required": false,
1008
+ "type": "string"
1009
+ },
1010
+ {
1011
+ "disabled": false,
1012
+ "document": "sql类型",
1013
+ "example": "无",
1014
+ "member": "string",
1015
+ "name": "SqlType",
1016
+ "required": false,
1017
+ "type": "string"
1018
+ },
1019
+ {
1020
+ "disabled": false,
1021
+ "document": "sql语句",
1022
+ "example": "sql",
1023
+ "member": "string",
1024
+ "name": "Sql",
1025
+ "required": false,
1026
+ "type": "string"
1027
+ },
1028
+ {
1029
+ "disabled": false,
1030
+ "document": "用户 （多选）",
1031
+ "example": "无",
1032
+ "member": "string",
1033
+ "name": "Users",
1034
+ "required": false,
1035
+ "type": "list"
1036
+ },
1037
+ {
1038
+ "disabled": false,
1039
+ "document": "数据库 （多选）",
1040
+ "example": "无",
1041
+ "member": "string",
1042
+ "name": "DbNames",
1043
+ "required": false,
1044
+ "type": "list"
1045
+ },
1046
+ {
1047
+ "disabled": false,
1048
+ "document": "sql类型 （多选）",
1049
+ "example": "无",
1050
+ "member": "string",
1051
+ "name": "SqlTypes",
1052
+ "required": false,
1053
+ "type": "list"
1054
+ },
1055
+ {
1056
+ "disabled": false,
1057
+ "document": "catalog名称（多选）",
1058
+ "example": "无",
1059
+ "member": "string",
1060
+ "name": "Catalogs",
1061
+ "required": false,
1062
+ "type": "list"
1063
+ }
1064
+ ],
1065
+ "type": "object"
1066
+ },
1067
+ "DescribeDatabaseAuditRecordsResponse": {
1068
+ "document": "DescribeDatabaseAuditRecords返回参数结构体",
1069
+ "members": [
1070
+ {
1071
+ "disabled": false,
1072
+ "document": "总数",
1073
+ "example": "123",
1074
+ "member": "int64",
1075
+ "name": "TotalCount",
1076
+ "output_required": true,
1077
+ "type": "int",
1078
+ "value_allowed_null": false
1079
+ },
1080
+ {
1081
+ "disabled": false,
1082
+ "document": "记录列表",
1083
+ "example": "xx",
1084
+ "member": "DataBaseAuditRecord",
1085
+ "name": "SlowQueryRecords",
1086
+ "output_required": true,
1087
+ "type": "object",
1088
+ "value_allowed_null": false
1089
+ },
1090
+ {
1091
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1092
+ "member": "string",
1093
+ "name": "RequestId",
1094
+ "type": "string"
1095
+ }
1096
+ ],
1097
+ "type": "object"
1098
+ },
1099
+ "DescribeInstanceNodesInfoRequest": {
1100
+ "document": "DescribeInstanceNodesInfo请求参数结构体",
1101
+ "members": [
1102
+ {
1103
+ "disabled": false,
1104
+ "document": "集群id",
1105
+ "example": "cdwdoris-xxx",
1106
+ "member": "string",
1107
+ "name": "InstanceID",
1108
+ "required": true,
1109
+ "type": "string"
1110
+ }
1111
+ ],
1112
+ "type": "object"
1113
+ },
1114
+ "DescribeInstanceNodesInfoResponse": {
1115
+ "document": "DescribeInstanceNodesInfo返回参数结构体",
1116
+ "members": [
1117
+ {
1118
+ "disabled": false,
1119
+ "document": "Be节点\n注意：此字段可能返回 null，表示取不到有效值。",
1120
+ "example": "已废弃",
1121
+ "member": "string",
1122
+ "name": "BeNodes",
1123
+ "output_required": false,
1124
+ "type": "list",
1125
+ "value_allowed_null": true
1126
+ },
1127
+ {
1128
+ "disabled": false,
1129
+ "document": "Fe节点\n注意：此字段可能返回 null，表示取不到有效值。",
1130
+ "example": "已废弃",
1131
+ "member": "string",
1132
+ "name": "FeNodes",
1133
+ "output_required": false,
1134
+ "type": "list",
1135
+ "value_allowed_null": true
1136
+ },
1137
+ {
1138
+ "disabled": false,
1139
+ "document": "Fe master节点",
1140
+ "example": "无",
1141
+ "member": "string",
1142
+ "name": "FeMaster",
1143
+ "output_required": false,
1144
+ "type": "string",
1145
+ "value_allowed_null": false
1146
+ },
1147
+ {
1148
+ "disabled": false,
1149
+ "document": "Be节点信息\n注意：此字段可能返回 null，表示取不到有效值。",
1150
+ "example": "无",
1151
+ "member": "NodeInfo",
1152
+ "name": "BeNodeInfos",
1153
+ "output_required": false,
1154
+ "type": "list",
1155
+ "value_allowed_null": true
1156
+ },
1157
+ {
1158
+ "disabled": false,
1159
+ "document": "Fe节点信息\n注意：此字段可能返回 null，表示取不到有效值。",
1160
+ "example": "无",
1161
+ "member": "NodeInfo",
1162
+ "name": "FeNodeInfos",
1163
+ "output_required": false,
1164
+ "type": "list",
1165
+ "value_allowed_null": true
1166
+ },
1167
+ {
1168
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1169
+ "member": "string",
1170
+ "name": "RequestId",
1171
+ "type": "string"
1172
+ }
1173
+ ],
1174
+ "type": "object"
1175
+ },
1176
+ "DescribeInstanceNodesRequest": {
1177
+ "document": "DescribeInstanceNodes请求参数结构体",
1178
+ "members": [
1179
+ {
1180
+ "disabled": false,
1181
+ "document": "集群实例ID",
1182
+ "example": "cdwch-12345678",
1183
+ "member": "string",
1184
+ "name": "InstanceId",
1185
+ "required": true,
1186
+ "type": "string"
1187
+ },
1188
+ {
1189
+ "disabled": false,
1190
+ "document": "集群角色类型，默认为 \"data\"数据节点",
1191
+ "example": "DATA",
1192
+ "member": "string",
1193
+ "name": "NodeRole",
1194
+ "required": false,
1195
+ "type": "string"
1196
+ },
1197
+ {
1198
+ "disabled": false,
1199
+ "document": "分页参数，第一页为0，第二页为10",
1200
+ "example": "0",
1201
+ "member": "int64",
1202
+ "name": "Offset",
1203
+ "required": false,
1204
+ "type": "int"
1205
+ },
1206
+ {
1207
+ "disabled": false,
1208
+ "document": "分页参数，分页步长，默认为10",
1209
+ "example": "100",
1210
+ "member": "int64",
1211
+ "name": "Limit",
1212
+ "required": false,
1213
+ "type": "int"
1214
+ },
1215
+ {
1216
+ "disabled": false,
1217
+ "document": "展现策略，All时显示所有",
1218
+ "example": "All",
1219
+ "member": "string",
1220
+ "name": "DisplayPolicy",
1221
+ "required": false,
1222
+ "type": "string"
1223
+ }
1224
+ ],
1225
+ "type": "object"
1226
+ },
1227
+ "DescribeInstanceNodesResponse": {
1228
+ "document": "DescribeInstanceNodes返回参数结构体",
1229
+ "members": [
1230
+ {
1231
+ "disabled": false,
1232
+ "document": "总数",
1233
+ "example": "2",
1234
+ "member": "int64",
1235
+ "name": "TotalCount",
1236
+ "output_required": true,
1237
+ "type": "int",
1238
+ "value_allowed_null": false
1239
+ },
1240
+ {
1241
+ "disabled": false,
1242
+ "document": "实例节点总数\n注意：此字段可能返回 null，表示取不到有效值。",
1243
+ "example": "无",
1244
+ "member": "InstanceNode",
1245
+ "name": "InstanceNodesList",
1246
+ "output_required": true,
1247
+ "type": "list",
1248
+ "value_allowed_null": true
1249
+ },
1250
+ {
1251
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1252
+ "member": "string",
1253
+ "name": "RequestId",
1254
+ "type": "string"
1255
+ }
1256
+ ],
1257
+ "type": "object"
1258
+ },
1259
+ "DescribeInstanceRequest": {
1260
+ "document": "DescribeInstance请求参数结构体",
1261
+ "members": [
1262
+ {
1263
+ "disabled": false,
1264
+ "document": "集群实例ID",
1265
+ "example": "cdwch-12345678",
1266
+ "member": "string",
1267
+ "name": "InstanceId",
1268
+ "required": true,
1269
+ "type": "string"
1270
+ }
1271
+ ],
1272
+ "type": "object"
1273
+ },
1274
+ "DescribeInstanceResponse": {
1275
+ "document": "DescribeInstance返回参数结构体",
1276
+ "members": [
1277
+ {
1278
+ "disabled": false,
1279
+ "document": "实例描述信息",
1280
+ "example": "无",
1281
+ "member": "InstanceInfo",
1282
+ "name": "InstanceInfo",
1283
+ "output_required": true,
1284
+ "type": "object",
1285
+ "value_allowed_null": false
1286
+ },
1287
+ {
1288
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1289
+ "member": "string",
1290
+ "name": "RequestId",
1291
+ "type": "string"
1292
+ }
1293
+ ],
1294
+ "type": "object"
1295
+ },
1296
+ "DescribeInstanceStateRequest": {
1297
+ "document": "DescribeInstanceState请求参数结构体",
1298
+ "members": [
1299
+ {
1300
+ "disabled": false,
1301
+ "document": "集群实例名称",
1302
+ "example": "-",
1303
+ "member": "string",
1304
+ "name": "InstanceId",
1305
+ "required": true,
1306
+ "type": "string"
1307
+ }
1308
+ ],
1309
+ "type": "object"
1310
+ },
1311
+ "DescribeInstanceStateResponse": {
1312
+ "document": "DescribeInstanceState返回参数结构体",
1313
+ "members": [
1314
+ {
1315
+ "disabled": false,
1316
+ "document": "集群状态，例如：Serving",
1317
+ "example": "-",
1318
+ "member": "string",
1319
+ "name": "InstanceState",
1320
+ "output_required": true,
1321
+ "type": "string",
1322
+ "value_allowed_null": false
1323
+ },
1324
+ {
1325
+ "disabled": false,
1326
+ "document": "集群操作创建时间\n注意：此字段可能返回 null，表示取不到有效值。",
1327
+ "example": "-",
1328
+ "member": "string",
1329
+ "name": "FlowCreateTime",
1330
+ "output_required": true,
1331
+ "type": "string",
1332
+ "value_allowed_null": true
1333
+ },
1334
+ {
1335
+ "disabled": false,
1336
+ "document": "集群操作名称\n注意：此字段可能返回 null，表示取不到有效值。",
1337
+ "example": "-",
1338
+ "member": "string",
1339
+ "name": "FlowName",
1340
+ "output_required": true,
1341
+ "type": "string",
1342
+ "value_allowed_null": true
1343
+ },
1344
+ {
1345
+ "disabled": false,
1346
+ "document": "集群操作进度\n注意：此字段可能返回 null，表示取不到有效值。",
1347
+ "example": "-",
1348
+ "member": "float",
1349
+ "name": "FlowProgress",
1350
+ "output_required": true,
1351
+ "type": "float",
1352
+ "value_allowed_null": true
1353
+ },
1354
+ {
1355
+ "disabled": false,
1356
+ "document": "集群状态描述，例如：运行中\n注意：此字段可能返回 null，表示取不到有效值。",
1357
+ "example": "-",
1358
+ "member": "string",
1359
+ "name": "InstanceStateDesc",
1360
+ "output_required": true,
1361
+ "type": "string",
1362
+ "value_allowed_null": true
1363
+ },
1364
+ {
1365
+ "disabled": false,
1366
+ "document": "集群流程错误信息，例如：“创建失败，资源不足”\n注意：此字段可能返回 null，表示取不到有效值。",
1367
+ "example": "-",
1368
+ "member": "string",
1369
+ "name": "FlowMsg",
1370
+ "output_required": true,
1371
+ "type": "string",
1372
+ "value_allowed_null": true
1373
+ },
1374
+ {
1375
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1376
+ "member": "string",
1377
+ "name": "RequestId",
1378
+ "type": "string"
1379
+ }
1380
+ ],
1381
+ "type": "object"
1382
+ },
1383
+ "DescribeInstancesRequest": {
1384
+ "document": "DescribeInstances请求参数结构体",
1385
+ "members": [
1386
+ {
1387
+ "disabled": false,
1388
+ "document": "搜索的集群id名称",
1389
+ "example": "cdwch-xxxx",
1390
+ "member": "string",
1391
+ "name": "SearchInstanceId",
1392
+ "required": false,
1393
+ "type": "string"
1394
+ },
1395
+ {
1396
+ "disabled": false,
1397
+ "document": "搜索的集群name",
1398
+ "example": "-",
1399
+ "member": "string",
1400
+ "name": "SearchInstanceName",
1401
+ "required": false,
1402
+ "type": "string"
1403
+ },
1404
+ {
1405
+ "disabled": false,
1406
+ "document": "分页参数，第一页为0，第二页为10",
1407
+ "example": "0",
1408
+ "member": "int64",
1409
+ "name": "Offset",
1410
+ "required": false,
1411
+ "type": "int"
1412
+ },
1413
+ {
1414
+ "disabled": false,
1415
+ "document": "分页参数，分页步长，默认为10",
1416
+ "example": "20",
1417
+ "member": "int64",
1418
+ "name": "Limit",
1419
+ "required": false,
1420
+ "type": "int"
1421
+ },
1422
+ {
1423
+ "disabled": false,
1424
+ "document": "搜索标签列表",
1425
+ "example": "无",
1426
+ "member": "SearchTags",
1427
+ "name": "SearchTags",
1428
+ "required": false,
1429
+ "type": "list"
1430
+ }
1431
+ ],
1432
+ "type": "object"
1433
+ },
1434
+ "DescribeInstancesResponse": {
1435
+ "document": "DescribeInstances返回参数结构体",
1436
+ "members": [
1437
+ {
1438
+ "disabled": false,
1439
+ "document": "实例总数",
1440
+ "example": "18",
1441
+ "member": "int64",
1442
+ "name": "TotalCount",
1443
+ "output_required": true,
1444
+ "type": "int",
1445
+ "value_allowed_null": false
1446
+ },
1447
+ {
1448
+ "disabled": false,
1449
+ "document": "实例数组",
1450
+ "example": "-",
1451
+ "member": "InstanceInfo",
1452
+ "name": "InstancesList",
1453
+ "output_required": true,
1454
+ "type": "list",
1455
+ "value_allowed_null": false
1456
+ },
1457
+ {
1458
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1459
+ "member": "string",
1460
+ "name": "RequestId",
1461
+ "type": "string"
1462
+ }
1463
+ ],
1464
+ "type": "object"
1465
+ },
1466
+ "DescribeSlowQueryRecordsDownloadRequest": {
1467
+ "document": "DescribeSlowQueryRecordsDownload请求参数结构体",
1468
+ "members": [
1469
+ {
1470
+ "disabled": false,
1471
+ "document": "实例ID",
1472
+ "example": "xx",
1473
+ "member": "string",
1474
+ "name": "InstanceId",
1475
+ "required": true,
1476
+ "type": "string"
1477
+ },
1478
+ {
1479
+ "disabled": false,
1480
+ "document": "慢查询时间",
1481
+ "example": "xx",
1482
+ "member": "int64",
1483
+ "name": "QueryDurationMs",
1484
+ "required": true,
1485
+ "type": "int"
1486
+ },
1487
+ {
1488
+ "disabled": false,
1489
+ "document": "开始时间",
1490
+ "example": "xx",
1491
+ "member": "string",
1492
+ "name": "StartTime",
1493
+ "required": true,
1494
+ "type": "string"
1495
+ },
1496
+ {
1497
+ "disabled": false,
1498
+ "document": "结束时间",
1499
+ "example": "xx",
1500
+ "member": "string",
1501
+ "name": "EndTime",
1502
+ "required": true,
1503
+ "type": "string"
1504
+ },
1505
+ {
1506
+ "disabled": false,
1507
+ "document": "排序参数",
1508
+ "example": "xx",
1509
+ "member": "string",
1510
+ "name": "DurationMs",
1511
+ "required": false,
1512
+ "type": "string"
1513
+ }
1514
+ ],
1515
+ "type": "object"
1516
+ },
1517
+ "DescribeSlowQueryRecordsDownloadResponse": {
1518
+ "document": "DescribeSlowQueryRecordsDownload返回参数结构体",
1519
+ "members": [
1520
+ {
1521
+ "disabled": false,
1522
+ "document": "cos地址",
1523
+ "example": "xx",
1524
+ "member": "string",
1525
+ "name": "CosUrl",
1526
+ "output_required": true,
1527
+ "type": "string",
1528
+ "value_allowed_null": false
1529
+ },
1530
+ {
1531
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1532
+ "member": "string",
1533
+ "name": "RequestId",
1534
+ "type": "string"
1535
+ }
1536
+ ],
1537
+ "type": "object"
1538
+ },
1539
+ "DescribeSlowQueryRecordsRequest": {
1540
+ "document": "DescribeSlowQueryRecords请求参数结构体",
1541
+ "members": [
1542
+ {
1543
+ "disabled": false,
1544
+ "document": "实例ID",
1545
+ "example": "cdwdoris-64h6w432",
1546
+ "member": "string",
1547
+ "name": "InstanceId",
1548
+ "required": true,
1549
+ "type": "string"
1550
+ },
1551
+ {
1552
+ "disabled": false,
1553
+ "document": "慢查询时间",
1554
+ "example": "100",
1555
+ "member": "int64",
1556
+ "name": "QueryDurationMs",
1557
+ "required": true,
1558
+ "type": "int"
1559
+ },
1560
+ {
1561
+ "disabled": false,
1562
+ "document": "开始时间",
1563
+ "example": "abc",
1564
+ "member": "string",
1565
+ "name": "StartTime",
1566
+ "required": true,
1567
+ "type": "string"
1568
+ },
1569
+ {
1570
+ "disabled": false,
1571
+ "document": "结束时间",
1572
+ "example": "abc",
1573
+ "member": "string",
1574
+ "name": "EndTime",
1575
+ "required": true,
1576
+ "type": "string"
1577
+ },
1578
+ {
1579
+ "disabled": false,
1580
+ "document": "分页",
1581
+ "example": "1",
1582
+ "member": "int64",
1583
+ "name": "PageSize",
1584
+ "required": true,
1585
+ "type": "int"
1586
+ },
1587
+ {
1588
+ "disabled": false,
1589
+ "document": "分页",
1590
+ "example": "1",
1591
+ "member": "int64",
1592
+ "name": "PageNum",
1593
+ "required": true,
1594
+ "type": "int"
1595
+ },
1596
+ {
1597
+ "disabled": false,
1598
+ "document": "排序参数",
1599
+ "example": "abc",
1600
+ "member": "string",
1601
+ "name": "DurationMs",
1602
+ "required": false,
1603
+ "type": "string"
1604
+ },
1605
+ {
1606
+ "disabled": false,
1607
+ "document": "数据库名称",
1608
+ "example": "[\"xx\",\"xxx\"]",
1609
+ "member": "string",
1610
+ "name": "DbName",
1611
+ "required": false,
1612
+ "type": "list"
1613
+ },
1614
+ {
1615
+ "disabled": false,
1616
+ "document": "是否是查询，0：否， 1：是",
1617
+ "example": "1",
1618
+ "member": "int64",
1619
+ "name": "IsQuery",
1620
+ "required": false,
1621
+ "type": "int"
1622
+ },
1623
+ {
1624
+ "disabled": false,
1625
+ "document": "catalog名称",
1626
+ "example": "[\"xx\",\"xxx\"]",
1627
+ "member": "string",
1628
+ "name": "CatalogName",
1629
+ "required": false,
1630
+ "type": "list"
1631
+ }
1632
+ ],
1633
+ "type": "object"
1634
+ },
1635
+ "DescribeSlowQueryRecordsResponse": {
1636
+ "document": "DescribeSlowQueryRecords返回参数结构体",
1637
+ "members": [
1638
+ {
1639
+ "disabled": false,
1640
+ "document": "总数",
1641
+ "example": "123",
1642
+ "member": "int64",
1643
+ "name": "TotalCount",
1644
+ "output_required": true,
1645
+ "type": "int",
1646
+ "value_allowed_null": false
1647
+ },
1648
+ {
1649
+ "disabled": false,
1650
+ "document": "记录列表",
1651
+ "example": "[\"xx\",\"abc\"",
1652
+ "member": "SlowQueryRecord",
1653
+ "name": "SlowQueryRecords",
1654
+ "output_required": true,
1655
+ "type": "list",
1656
+ "value_allowed_null": false
1657
+ },
1658
+ {
1659
+ "disabled": false,
1660
+ "document": "所有数据库名\n注意：此字段可能返回 null，表示取不到有效值。",
1661
+ "example": "无",
1662
+ "member": "string",
1663
+ "name": "DBNameList",
1664
+ "output_required": false,
1665
+ "type": "list",
1666
+ "value_allowed_null": true
1667
+ },
1668
+ {
1669
+ "disabled": false,
1670
+ "document": "所有catalog名\n注意：此字段可能返回 null，表示取不到有效值。",
1671
+ "example": "无",
1672
+ "member": "string",
1673
+ "name": "CatalogNameList",
1674
+ "output_required": false,
1675
+ "type": "list",
1676
+ "value_allowed_null": true
1677
+ },
1678
+ {
1679
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1680
+ "member": "string",
1681
+ "name": "RequestId",
1682
+ "type": "string"
1683
+ }
1684
+ ],
1685
+ "type": "object"
1686
+ },
1687
+ "DestroyInstanceRequest": {
1688
+ "document": "DestroyInstance请求参数结构体",
1689
+ "members": [
1690
+ {
1691
+ "disabled": false,
1692
+ "document": "集群ID",
1693
+ "example": "无",
1694
+ "member": "string",
1695
+ "name": "InstanceId",
1696
+ "required": true,
1697
+ "type": "string"
1698
+ }
1699
+ ],
1700
+ "type": "object"
1701
+ },
1702
+ "DestroyInstanceResponse": {
1703
+ "document": "DestroyInstance返回参数结构体",
1704
+ "members": [
1705
+ {
1706
+ "disabled": false,
1707
+ "document": "流程ID",
1708
+ "example": "无",
1709
+ "member": "string",
1710
+ "name": "FlowId",
1711
+ "output_required": false,
1712
+ "type": "string",
1713
+ "value_allowed_null": false
1714
+ },
1715
+ {
1716
+ "disabled": false,
1717
+ "document": "集群ID",
1718
+ "example": "无",
1719
+ "member": "string",
1720
+ "name": "InstanceId",
1721
+ "output_required": false,
1722
+ "type": "string",
1723
+ "value_allowed_null": false
1724
+ },
1725
+ {
1726
+ "disabled": false,
1727
+ "document": "错误信息",
1728
+ "example": "无",
1729
+ "member": "string",
1730
+ "name": "ErrorMsg",
1731
+ "output_required": false,
1732
+ "type": "string",
1733
+ "value_allowed_null": false
1734
+ },
1735
+ {
1736
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1737
+ "member": "string",
1738
+ "name": "RequestId",
1739
+ "type": "string"
1740
+ }
1741
+ ],
1742
+ "type": "object"
1743
+ },
1744
+ "InstanceInfo": {
1745
+ "document": "实例描述信息",
1746
+ "members": [
1747
+ {
1748
+ "disabled": false,
1749
+ "document": "集群实例ID, \"cdw-xxxx\" 字符串类型\n注意：此字段可能返回 null，表示取不到有效值。",
1750
+ "example": "cdwch-xxxxxxxx",
1751
+ "member": "string",
1752
+ "name": "InstanceId",
1753
+ "output_required": true,
1754
+ "type": "string",
1755
+ "value_allowed_null": true
1756
+ },
1757
+ {
1758
+ "disabled": false,
1759
+ "document": "集群实例名称\n注意：此字段可能返回 null，表示取不到有效值。",
1760
+ "example": "clickhouse集群",
1761
+ "member": "string",
1762
+ "name": "InstanceName",
1763
+ "output_required": true,
1764
+ "type": "string",
1765
+ "value_allowed_null": true
1766
+ },
1767
+ {
1768
+ "disabled": false,
1769
+ "document": "状态,\nInit 创建中; Serving 运行中； \nDeleted已销毁；Deleting 销毁中；\nModify 集群变更中；\n注意：此字段可能返回 null，表示取不到有效值。",
1770
+ "example": "Running",
1771
+ "member": "string",
1772
+ "name": "Status",
1773
+ "output_required": true,
1774
+ "type": "string",
1775
+ "value_allowed_null": true
1776
+ },
1777
+ {
1778
+ "disabled": false,
1779
+ "document": "版本\n注意：此字段可能返回 null，表示取不到有效值。",
1780
+ "example": "20.7.2.30",
1781
+ "member": "string",
1782
+ "name": "Version",
1783
+ "output_required": true,
1784
+ "type": "string",
1785
+ "value_allowed_null": true
1786
+ },
1787
+ {
1788
+ "disabled": false,
1789
+ "document": "地域, ap-guangzhou\n注意：此字段可能返回 null，表示取不到有效值。",
1790
+ "example": "ap-guangzhou",
1791
+ "member": "string",
1792
+ "name": "Region",
1793
+ "output_required": true,
1794
+ "type": "string",
1795
+ "value_allowed_null": true
1796
+ },
1797
+ {
1798
+ "disabled": false,
1799
+ "document": "可用区， ap-guangzhou-3\n注意：此字段可能返回 null，表示取不到有效值。",
1800
+ "example": "ap-guangzhou-3",
1801
+ "member": "string",
1802
+ "name": "Zone",
1803
+ "output_required": true,
1804
+ "type": "string",
1805
+ "value_allowed_null": true
1806
+ },
1807
+ {
1808
+ "disabled": false,
1809
+ "document": "私有网络名称\n注意：此字段可能返回 null，表示取不到有效值。",
1810
+ "example": "vpc-xxxxxx",
1811
+ "member": "string",
1812
+ "name": "VpcId",
1813
+ "output_required": true,
1814
+ "type": "string",
1815
+ "value_allowed_null": true
1816
+ },
1817
+ {
1818
+ "disabled": false,
1819
+ "document": "子网名称\n注意：此字段可能返回 null，表示取不到有效值。",
1820
+ "example": "subnet-xxxxx",
1821
+ "member": "string",
1822
+ "name": "SubnetId",
1823
+ "output_required": true,
1824
+ "type": "string",
1825
+ "value_allowed_null": true
1826
+ },
1827
+ {
1828
+ "disabled": false,
1829
+ "document": "付费类型，\"hour\", \"prepay\"\n注意：此字段可能返回 null，表示取不到有效值。",
1830
+ "example": "hour",
1831
+ "member": "string",
1832
+ "name": "PayMode",
1833
+ "output_required": true,
1834
+ "type": "string",
1835
+ "value_allowed_null": true
1836
+ },
1837
+ {
1838
+ "disabled": false,
1839
+ "document": "创建时间\n注意：此字段可能返回 null，表示取不到有效值。",
1840
+ "example": "2020-01-01 11:11:11",
1841
+ "member": "string",
1842
+ "name": "CreateTime",
1843
+ "output_required": true,
1844
+ "type": "string",
1845
+ "value_allowed_null": true
1846
+ },
1847
+ {
1848
+ "disabled": false,
1849
+ "document": "过期时间\n注意：此字段可能返回 null，表示取不到有效值。",
1850
+ "example": "2020-02-01 11:11:11",
1851
+ "member": "string",
1852
+ "name": "ExpireTime",
1853
+ "output_required": true,
1854
+ "type": "string",
1855
+ "value_allowed_null": true
1856
+ },
1857
+ {
1858
+ "disabled": false,
1859
+ "document": "数据节点描述信息\n注意：此字段可能返回 null，表示取不到有效值。",
1860
+ "example": "无",
1861
+ "member": "NodesSummary",
1862
+ "name": "MasterSummary",
1863
+ "output_required": false,
1864
+ "type": "object",
1865
+ "value_allowed_null": true
1866
+ },
1867
+ {
1868
+ "disabled": false,
1869
+ "document": "zookeeper节点描述信息\n注意：此字段可能返回 null，表示取不到有效值。",
1870
+ "example": "无",
1871
+ "member": "NodesSummary",
1872
+ "name": "CoreSummary",
1873
+ "output_required": false,
1874
+ "type": "object",
1875
+ "value_allowed_null": true
1876
+ },
1877
+ {
1878
+ "disabled": false,
1879
+ "document": "高可用，“true\" \"false\"\n注意：此字段可能返回 null，表示取不到有效值。",
1880
+ "example": "false",
1881
+ "member": "string",
1882
+ "name": "HA",
1883
+ "output_required": true,
1884
+ "type": "string",
1885
+ "value_allowed_null": true
1886
+ },
1887
+ {
1888
+ "disabled": false,
1889
+ "document": "高可用类型：\n0：非高可用\n1：读高可用\n2：读写高可用。\n注意：此字段可能返回 null，表示取不到有效值。",
1890
+ "example": "1",
1891
+ "member": "int64",
1892
+ "name": "HaType",
1893
+ "output_required": false,
1894
+ "type": "int",
1895
+ "value_allowed_null": true
1896
+ },
1897
+ {
1898
+ "disabled": false,
1899
+ "document": "访问地址，例如 \"10.0.0.1:9000\"\n注意：此字段可能返回 null，表示取不到有效值。",
1900
+ "example": "\"10.0.0.1:9000\"",
1901
+ "member": "string",
1902
+ "name": "AccessInfo",
1903
+ "output_required": true,
1904
+ "type": "string",
1905
+ "value_allowed_null": true
1906
+ },
1907
+ {
1908
+ "disabled": false,
1909
+ "document": "记录ID，数值型\n注意：此字段可能返回 null，表示取不到有效值。",
1910
+ "example": "1",
1911
+ "member": "int64",
1912
+ "name": "Id",
1913
+ "output_required": true,
1914
+ "type": "int",
1915
+ "value_allowed_null": true
1916
+ },
1917
+ {
1918
+ "disabled": false,
1919
+ "document": "regionId, 表示地域\n注意：此字段可能返回 null，表示取不到有效值。",
1920
+ "example": "1",
1921
+ "member": "int64",
1922
+ "name": "RegionId",
1923
+ "output_required": true,
1924
+ "type": "int",
1925
+ "value_allowed_null": true
1926
+ },
1927
+ {
1928
+ "disabled": false,
1929
+ "document": "可用区说明，例如 \"广州二区\"\n注意：此字段可能返回 null，表示取不到有效值。",
1930
+ "example": "广州三区",
1931
+ "member": "string",
1932
+ "name": "ZoneDesc",
1933
+ "output_required": true,
1934
+ "type": "string",
1935
+ "value_allowed_null": true
1936
+ },
1937
+ {
1938
+ "disabled": false,
1939
+ "document": "错误流程说明信息\n注意：此字段可能返回 null，表示取不到有效值。",
1940
+ "example": "\"\"",
1941
+ "member": "string",
1942
+ "name": "FlowMsg",
1943
+ "output_required": true,
1944
+ "type": "string",
1945
+ "value_allowed_null": true
1946
+ },
1947
+ {
1948
+ "disabled": false,
1949
+ "document": "状态描述，例如“运行中”等\n注意：此字段可能返回 null，表示取不到有效值。",
1950
+ "example": "运行中",
1951
+ "member": "string",
1952
+ "name": "StatusDesc",
1953
+ "output_required": true,
1954
+ "type": "string",
1955
+ "value_allowed_null": true
1956
+ },
1957
+ {
1958
+ "disabled": false,
1959
+ "document": "自动续费标记\n注意：此字段可能返回 null，表示取不到有效值。",
1960
+ "example": "false",
1961
+ "member": "bool",
1962
+ "name": "RenewFlag",
1963
+ "output_required": true,
1964
+ "type": "bool",
1965
+ "value_allowed_null": true
1966
+ },
1967
+ {
1968
+ "disabled": false,
1969
+ "document": "标签列表\n注意：此字段可能返回 null，表示取不到有效值。",
1970
+ "example": "无",
1971
+ "member": "Tag",
1972
+ "name": "Tags",
1973
+ "output_required": true,
1974
+ "type": "list",
1975
+ "value_allowed_null": true
1976
+ },
1977
+ {
1978
+ "disabled": false,
1979
+ "document": "监控信息\n注意：此字段可能返回 null，表示取不到有效值。",
1980
+ "example": "prom-aaaaa",
1981
+ "member": "string",
1982
+ "name": "Monitor",
1983
+ "output_required": true,
1984
+ "type": "string",
1985
+ "value_allowed_null": true
1986
+ },
1987
+ {
1988
+ "disabled": false,
1989
+ "document": "是否开通日志\n注意：此字段可能返回 null，表示取不到有效值。",
1990
+ "example": "true",
1991
+ "member": "bool",
1992
+ "name": "HasClsTopic",
1993
+ "output_required": true,
1994
+ "type": "bool",
1995
+ "value_allowed_null": true
1996
+ },
1997
+ {
1998
+ "disabled": false,
1999
+ "document": "日志主题ID\n注意：此字段可能返回 null，表示取不到有效值。",
2000
+ "example": "xxx",
2001
+ "member": "string",
2002
+ "name": "ClsTopicId",
2003
+ "output_required": true,
2004
+ "type": "string",
2005
+ "value_allowed_null": true
2006
+ },
2007
+ {
2008
+ "disabled": false,
2009
+ "document": "日志集ID\n注意：此字段可能返回 null，表示取不到有效值。",
2010
+ "example": "xxx",
2011
+ "member": "string",
2012
+ "name": "ClsLogSetId",
2013
+ "output_required": true,
2014
+ "type": "string",
2015
+ "value_allowed_null": true
2016
+ },
2017
+ {
2018
+ "disabled": false,
2019
+ "document": "是否支持xml配置管理\n注意：此字段可能返回 null，表示取不到有效值。",
2020
+ "example": "1",
2021
+ "member": "int64",
2022
+ "name": "EnableXMLConfig",
2023
+ "output_required": true,
2024
+ "type": "int",
2025
+ "value_allowed_null": true
2026
+ },
2027
+ {
2028
+ "disabled": false,
2029
+ "document": "区域\n注意：此字段可能返回 null，表示取不到有效值。",
2030
+ "example": "广州",
2031
+ "member": "string",
2032
+ "name": "RegionDesc",
2033
+ "output_required": true,
2034
+ "type": "string",
2035
+ "value_allowed_null": true
2036
+ },
2037
+ {
2038
+ "disabled": false,
2039
+ "document": "弹性网卡地址\n注意：此字段可能返回 null，表示取不到有效值。",
2040
+ "example": "127.0.0.1",
2041
+ "member": "string",
2042
+ "name": "Eip",
2043
+ "output_required": true,
2044
+ "type": "string",
2045
+ "value_allowed_null": true
2046
+ },
584
2047
  {
585
2048
  "disabled": false,
586
2049
  "document": "冷热分层系数\n注意：此字段可能返回 null，表示取不到有效值。",
587
2050
  "example": "20",
588
2051
  "member": "int64",
589
- "name": "CosMoveFactor",
2052
+ "name": "CosMoveFactor",
2053
+ "output_required": true,
2054
+ "type": "int",
2055
+ "value_allowed_null": true
2056
+ },
2057
+ {
2058
+ "disabled": false,
2059
+ "document": "external/local/yunti\n注意：此字段可能返回 null，表示取不到有效值。",
2060
+ "example": "yunti",
2061
+ "member": "string",
2062
+ "name": "Kind",
2063
+ "output_required": true,
2064
+ "type": "string",
2065
+ "value_allowed_null": true
2066
+ },
2067
+ {
2068
+ "disabled": false,
2069
+ "document": "cos桶\n注意：此字段可能返回 null，表示取不到有效值。",
2070
+ "example": "无",
2071
+ "member": "string",
2072
+ "name": "CosBucketName",
2073
+ "output_required": false,
2074
+ "type": "string",
2075
+ "value_allowed_null": true
2076
+ },
2077
+ {
2078
+ "disabled": false,
2079
+ "document": "cbs\n注意：此字段可能返回 null，表示取不到有效值。",
2080
+ "example": "无",
2081
+ "member": "bool",
2082
+ "name": "CanAttachCbs",
2083
+ "output_required": false,
2084
+ "type": "bool",
2085
+ "value_allowed_null": true
2086
+ },
2087
+ {
2088
+ "disabled": false,
2089
+ "document": "小版本\n注意：此字段可能返回 null，表示取不到有效值。",
2090
+ "example": "无",
2091
+ "member": "string",
2092
+ "name": "BuildVersion",
2093
+ "output_required": false,
2094
+ "type": "string",
2095
+ "value_allowed_null": true
2096
+ },
2097
+ {
2098
+ "disabled": false,
2099
+ "document": "组件信息\n注意：此字段可能返回 null，表示取不到有效值。",
2100
+ "example": "无",
2101
+ "member": "string",
2102
+ "name": "Components",
2103
+ "output_required": false,
2104
+ "type": "string",
2105
+ "value_allowed_null": true
2106
+ },
2107
+ {
2108
+ "disabled": true,
2109
+ "document": "判断审计日志表是否有catalog字段\n注意：此字段可能返回 null，表示取不到有效值。",
2110
+ "example": "0",
2111
+ "member": "int64",
2112
+ "name": "IfExistCatalog",
2113
+ "output_required": false,
2114
+ "type": "int",
2115
+ "value_allowed_null": true
2116
+ },
2117
+ {
2118
+ "disabled": false,
2119
+ "document": "页面特性，用于前端屏蔽一些页面入口\n注意：此字段可能返回 null，表示取不到有效值。",
2120
+ "example": "[\"catalog\",\"xx\"]",
2121
+ "member": "string",
2122
+ "name": "Characteristic",
2123
+ "output_required": false,
2124
+ "type": "list",
2125
+ "value_allowed_null": true
2126
+ },
2127
+ {
2128
+ "disabled": false,
2129
+ "document": "超时时间 单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2130
+ "example": "无",
2131
+ "member": "string",
2132
+ "name": "RestartTimeout",
2133
+ "output_required": false,
2134
+ "type": "string",
2135
+ "value_allowed_null": true
2136
+ },
2137
+ {
2138
+ "disabled": false,
2139
+ "document": "内核优雅重启超时时间，如果为-1说明未设置\n注意：此字段可能返回 null，表示取不到有效值。",
2140
+ "example": "无",
2141
+ "member": "string",
2142
+ "name": "GraceShutdownWaitSeconds",
2143
+ "output_required": false,
2144
+ "type": "string",
2145
+ "value_allowed_null": true
2146
+ },
2147
+ {
2148
+ "disabled": false,
2149
+ "document": "表名大小写是否敏感，0：敏感；1：不敏感，以小写进行比较；2：不敏感，表名改为以小写存储\n注意：此字段可能返回 null，表示取不到有效值。",
2150
+ "example": "0",
2151
+ "member": "int64",
2152
+ "name": "CaseSensitive",
2153
+ "output_required": false,
2154
+ "type": "int",
2155
+ "value_allowed_null": true
2156
+ }
2157
+ ],
2158
+ "usage": "out"
2159
+ },
2160
+ "InstanceNode": {
2161
+ "document": "实例节点描述信息",
2162
+ "members": [
2163
+ {
2164
+ "disabled": false,
2165
+ "document": "IP地址",
2166
+ "example": "10.0.0.1",
2167
+ "member": "string",
2168
+ "name": "Ip",
2169
+ "output_required": true,
2170
+ "type": "string",
2171
+ "value_allowed_null": false
2172
+ },
2173
+ {
2174
+ "disabled": false,
2175
+ "document": "机型，如 S1",
2176
+ "example": "SCH1",
2177
+ "member": "string",
2178
+ "name": "Spec",
2179
+ "output_required": true,
2180
+ "type": "string",
2181
+ "value_allowed_null": false
2182
+ },
2183
+ {
2184
+ "disabled": false,
2185
+ "document": "cpu核数",
2186
+ "example": "2",
2187
+ "member": "int64",
2188
+ "name": "Core",
2189
+ "output_required": true,
2190
+ "type": "int",
2191
+ "value_allowed_null": false
2192
+ },
2193
+ {
2194
+ "disabled": false,
2195
+ "document": "内存大小",
2196
+ "example": "4",
2197
+ "member": "int64",
2198
+ "name": "Memory",
2199
+ "output_required": true,
2200
+ "type": "int",
2201
+ "value_allowed_null": false
2202
+ },
2203
+ {
2204
+ "disabled": false,
2205
+ "document": "磁盘类型",
2206
+ "example": "CLOUD_HSSD",
2207
+ "member": "string",
2208
+ "name": "DiskType",
2209
+ "output_required": true,
2210
+ "type": "string",
2211
+ "value_allowed_null": false
2212
+ },
2213
+ {
2214
+ "disabled": false,
2215
+ "document": "磁盘大小",
2216
+ "example": "100",
2217
+ "member": "int64",
2218
+ "name": "DiskSize",
2219
+ "output_required": true,
2220
+ "type": "int",
2221
+ "value_allowed_null": false
2222
+ },
2223
+ {
2224
+ "disabled": false,
2225
+ "document": "所属clickhouse cluster名称",
2226
+ "example": "default_cluster",
2227
+ "member": "string",
2228
+ "name": "Role",
2229
+ "output_required": true,
2230
+ "type": "string",
2231
+ "value_allowed_null": false
2232
+ },
2233
+ {
2234
+ "disabled": false,
2235
+ "document": "状态\n注意：此字段可能返回 null，表示取不到有效值。",
2236
+ "example": "无",
2237
+ "member": "string",
2238
+ "name": "Status",
2239
+ "output_required": false,
2240
+ "type": "string",
2241
+ "value_allowed_null": true
2242
+ },
2243
+ {
2244
+ "disabled": false,
2245
+ "document": "rip\n注意：此字段可能返回 null，表示取不到有效值。",
2246
+ "example": "无",
2247
+ "member": "string",
2248
+ "name": "Rip",
2249
+ "output_required": false,
2250
+ "type": "string",
2251
+ "value_allowed_null": true
2252
+ },
2253
+ {
2254
+ "disabled": false,
2255
+ "document": "FE节点角色\n注意：此字段可能返回 null，表示取不到有效值。",
2256
+ "example": "leader",
2257
+ "member": "string",
2258
+ "name": "FeRole",
2259
+ "output_required": false,
2260
+ "type": "string",
2261
+ "value_allowed_null": true
2262
+ },
2263
+ {
2264
+ "disabled": false,
2265
+ "document": "UUID\n注意：此字段可能返回 null，表示取不到有效值。",
2266
+ "example": "2e8ed58d-bbf8-48f2-bfa6-3c5b3f4b9xas",
2267
+ "member": "string",
2268
+ "name": "UUID",
2269
+ "output_required": false,
2270
+ "type": "string",
2271
+ "value_allowed_null": true
2272
+ }
2273
+ ],
2274
+ "usage": "out"
2275
+ },
2276
+ "ModifyInstanceRequest": {
2277
+ "document": "ModifyInstance请求参数结构体",
2278
+ "members": [
2279
+ {
2280
+ "disabled": false,
2281
+ "document": "实例Id",
2282
+ "example": "cdwch-12345678",
2283
+ "member": "string",
2284
+ "name": "InstanceId",
2285
+ "required": true,
2286
+ "type": "string"
2287
+ },
2288
+ {
2289
+ "disabled": false,
2290
+ "document": "新修改的实例名称",
2291
+ "example": "cdwch-test",
2292
+ "member": "string",
2293
+ "name": "InstanceName",
2294
+ "required": true,
2295
+ "type": "string"
2296
+ }
2297
+ ],
2298
+ "type": "object"
2299
+ },
2300
+ "ModifyInstanceResponse": {
2301
+ "document": "ModifyInstance返回参数结构体",
2302
+ "members": [
2303
+ {
2304
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2305
+ "member": "string",
2306
+ "name": "RequestId",
2307
+ "type": "string"
2308
+ }
2309
+ ],
2310
+ "type": "object"
2311
+ },
2312
+ "NodeInfo": {
2313
+ "document": "NodeInfo",
2314
+ "members": [
2315
+ {
2316
+ "disabled": false,
2317
+ "document": "用户IP\n注意：此字段可能返回 null，表示取不到有效值。",
2318
+ "example": "无",
2319
+ "member": "string",
2320
+ "name": "Ip",
2321
+ "output_required": false,
2322
+ "type": "string",
2323
+ "value_allowed_null": true
2324
+ },
2325
+ {
2326
+ "disabled": false,
2327
+ "document": "节点状态\n注意：此字段可能返回 null，表示取不到有效值。",
2328
+ "example": "无",
2329
+ "member": "int64",
2330
+ "name": "Status",
2331
+ "output_required": false,
2332
+ "type": "int",
2333
+ "value_allowed_null": true
2334
+ }
2335
+ ],
2336
+ "usage": "out"
2337
+ },
2338
+ "NodesSummary": {
2339
+ "document": "节点角色描述信息",
2340
+ "members": [
2341
+ {
2342
+ "disabled": false,
2343
+ "document": "机型，如 S1",
2344
+ "example": "xx",
2345
+ "member": "string",
2346
+ "name": "Spec",
2347
+ "output_required": true,
2348
+ "type": "string",
2349
+ "value_allowed_null": false
2350
+ },
2351
+ {
2352
+ "disabled": false,
2353
+ "document": "节点数目",
2354
+ "example": "1",
2355
+ "member": "int64",
2356
+ "name": "NodeSize",
590
2357
  "output_required": true,
591
2358
  "type": "int",
592
- "value_allowed_null": true
2359
+ "value_allowed_null": false
593
2360
  },
594
2361
  {
595
2362
  "disabled": false,
596
- "document": "external/local/yunti\n注意：此字段可能返回 null，表示取不到有效值。",
597
- "example": "yunti",
2363
+ "document": "cpu核数，单位个",
2364
+ "example": "2",
2365
+ "member": "int64",
2366
+ "name": "Core",
2367
+ "output_required": true,
2368
+ "type": "int",
2369
+ "value_allowed_null": false
2370
+ },
2371
+ {
2372
+ "disabled": false,
2373
+ "document": "内存大小，单位G",
2374
+ "example": "4",
2375
+ "member": "int64",
2376
+ "name": "Memory",
2377
+ "output_required": true,
2378
+ "type": "int",
2379
+ "value_allowed_null": false
2380
+ },
2381
+ {
2382
+ "disabled": false,
2383
+ "document": "磁盘大小，单位G",
2384
+ "example": "xx",
2385
+ "member": "int64",
2386
+ "name": "Disk",
2387
+ "output_required": true,
2388
+ "type": "int",
2389
+ "value_allowed_null": false
2390
+ },
2391
+ {
2392
+ "disabled": false,
2393
+ "document": "磁盘类型",
2394
+ "example": "xx",
598
2395
  "member": "string",
599
- "name": "Kind",
2396
+ "name": "DiskType",
2397
+ "output_required": true,
2398
+ "type": "string",
2399
+ "value_allowed_null": false
2400
+ },
2401
+ {
2402
+ "disabled": false,
2403
+ "document": "磁盘描述",
2404
+ "example": "xx",
2405
+ "member": "string",
2406
+ "name": "DiskDesc",
600
2407
  "output_required": true,
601
2408
  "type": "string",
2409
+ "value_allowed_null": false
2410
+ },
2411
+ {
2412
+ "disabled": false,
2413
+ "document": "挂载云盘信息\n注意：此字段可能返回 null，表示取不到有效值。",
2414
+ "example": "xx",
2415
+ "member": "AttachCBSSpec",
2416
+ "name": "AttachCBSSpec",
2417
+ "output_required": true,
2418
+ "type": "object",
602
2419
  "value_allowed_null": true
603
2420
  },
604
2421
  {
605
2422
  "disabled": false,
606
- "document": "cos桶\n注意：此字段可能返回 null，表示取不到有效值。",
607
- "example": "无",
2423
+ "document": "子产品名称\n注意：此字段可能返回 null，表示取不到有效值。",
2424
+ "example": "cdwdoris",
608
2425
  "member": "string",
609
- "name": "CosBucketName",
2426
+ "name": "SubProductType",
610
2427
  "output_required": false,
611
2428
  "type": "string",
612
2429
  "value_allowed_null": true
613
2430
  },
614
2431
  {
615
2432
  "disabled": false,
616
- "document": "cbs\n注意：此字段可能返回 null，表示取不到有效值。",
2433
+ "document": "规格核数\n注意：此字段可能返回 null，表示取不到有效值。",
617
2434
  "example": "无",
618
- "member": "bool",
619
- "name": "CanAttachCbs",
2435
+ "member": "int64",
2436
+ "name": "SpecCore",
620
2437
  "output_required": false,
621
- "type": "bool",
2438
+ "type": "int",
622
2439
  "value_allowed_null": true
623
2440
  },
624
2441
  {
625
2442
  "disabled": false,
626
- "document": "小版本\n注意：此字段可能返回 null，表示取不到有效值。",
2443
+ "document": "规格内存\n注意：此字段可能返回 null，表示取不到有效值。",
627
2444
  "example": "无",
628
- "member": "string",
629
- "name": "BuildVersion",
2445
+ "member": "int64",
2446
+ "name": "SpecMemory",
630
2447
  "output_required": false,
631
- "type": "string",
2448
+ "type": "int",
632
2449
  "value_allowed_null": true
633
2450
  },
634
2451
  {
635
2452
  "disabled": false,
636
- "document": "组件信息\n注意：此字段可能返回 null，表示取不到有效值。",
2453
+ "document": "磁盘大小\n注意：此字段可能返回 null，表示取不到有效值。",
637
2454
  "example": "无",
638
- "member": "string",
639
- "name": "Components",
2455
+ "member": "int64",
2456
+ "name": "DiskCount",
640
2457
  "output_required": false,
641
- "type": "string",
2458
+ "type": "int",
642
2459
  "value_allowed_null": true
643
2460
  },
644
2461
  {
645
- "disabled": true,
646
- "document": "判断审计日志表是否有catalog字段\n注意：此字段可能返回 null，表示取不到有效值。",
647
- "example": "0",
2462
+ "disabled": false,
2463
+ "document": "是否加密\n注意：此字段可能返回 null，表示取不到有效值。",
2464
+ "example": "无",
648
2465
  "member": "int64",
649
- "name": "IfExistCatalog",
2466
+ "name": "Encrypt",
650
2467
  "output_required": false,
651
2468
  "type": "int",
652
2469
  "value_allowed_null": true
653
2470
  },
654
2471
  {
655
2472
  "disabled": false,
656
- "document": "页面特性，用于前端屏蔽一些页面入口\n注意：此字段可能返回 null，表示取不到有效值。",
657
- "example": "[\"catalog\",\"xx\"]",
658
- "member": "string",
659
- "name": "Characteristic",
2473
+ "document": "最大磁盘\n注意：此字段可能返回 null，表示取不到有效值。",
2474
+ "example": "无",
2475
+ "member": "int64",
2476
+ "name": "MaxDiskSize",
660
2477
  "output_required": false,
661
- "type": "list",
2478
+ "type": "int",
662
2479
  "value_allowed_null": true
2480
+ }
2481
+ ],
2482
+ "usage": "out"
2483
+ },
2484
+ "ResizeDiskRequest": {
2485
+ "document": "ResizeDisk请求参数结构体",
2486
+ "members": [
2487
+ {
2488
+ "disabled": false,
2489
+ "document": "集群ID",
2490
+ "example": "无",
2491
+ "member": "string",
2492
+ "name": "InstanceId",
2493
+ "required": true,
2494
+ "type": "string"
663
2495
  },
664
2496
  {
665
2497
  "disabled": false,
666
- "document": "超时时间 单位s\n注意：此字段可能返回 null，表示取不到有效值。",
2498
+ "document": "角色（MATER/CORE），MASTER 对应 FE，CORE对应BE",
667
2499
  "example": "无",
668
2500
  "member": "string",
669
- "name": "RestartTimeout",
2501
+ "name": "Type",
2502
+ "required": true,
2503
+ "type": "string"
2504
+ },
2505
+ {
2506
+ "disabled": false,
2507
+ "document": "云盘大小",
2508
+ "example": "无",
2509
+ "member": "uint64",
2510
+ "name": "DiskSize",
2511
+ "required": true,
2512
+ "type": "int"
2513
+ }
2514
+ ],
2515
+ "type": "object"
2516
+ },
2517
+ "ResizeDiskResponse": {
2518
+ "document": "ResizeDisk返回参数结构体",
2519
+ "members": [
2520
+ {
2521
+ "disabled": false,
2522
+ "document": "实例ID",
2523
+ "example": "无",
2524
+ "member": "string",
2525
+ "name": "InstanceId",
670
2526
  "output_required": false,
671
2527
  "type": "string",
672
- "value_allowed_null": true
2528
+ "value_allowed_null": false
673
2529
  },
674
2530
  {
675
2531
  "disabled": false,
676
- "document": "内核优雅重启超时时间，如果为-1说明未设置\n注意：此字段可能返回 null，表示取不到有效值。",
2532
+ "document": "流程ID",
677
2533
  "example": "无",
678
2534
  "member": "string",
679
- "name": "GraceShutdownWaitSeconds",
2535
+ "name": "FlowId",
680
2536
  "output_required": false,
681
2537
  "type": "string",
682
- "value_allowed_null": true
2538
+ "value_allowed_null": false
683
2539
  },
684
2540
  {
685
2541
  "disabled": false,
686
- "document": "表名大小写是否敏感，0：敏感；1：不敏感，以小写进行比较；2：不敏感，表名改为以小写存储\n注意：此字段可能返回 null，表示取不到有效值。",
687
- "example": "0",
688
- "member": "int64",
689
- "name": "CaseSensitive",
2542
+ "document": "错误信息",
2543
+ "example": "无",
2544
+ "member": "string",
2545
+ "name": "ErrorMsg",
690
2546
  "output_required": false,
2547
+ "type": "string",
2548
+ "value_allowed_null": false
2549
+ },
2550
+ {
2551
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2552
+ "member": "string",
2553
+ "name": "RequestId",
2554
+ "type": "string"
2555
+ }
2556
+ ],
2557
+ "type": "object"
2558
+ },
2559
+ "RestartClusterForNodeRequest": {
2560
+ "document": "RestartClusterForNode请求参数结构体",
2561
+ "members": [
2562
+ {
2563
+ "disabled": false,
2564
+ "document": "集群ID，例如cdwch-xxxx",
2565
+ "example": "cdwch-xxxx",
2566
+ "member": "string",
2567
+ "name": "InstanceId",
2568
+ "required": true,
2569
+ "type": "string"
2570
+ },
2571
+ {
2572
+ "disabled": false,
2573
+ "document": "配置文件名称",
2574
+ "example": "fe/be/broken",
2575
+ "member": "string",
2576
+ "name": "ConfigName",
2577
+ "required": true,
2578
+ "type": "string"
2579
+ },
2580
+ {
2581
+ "disabled": false,
2582
+ "document": "每次重启的批次",
2583
+ "example": "1",
2584
+ "member": "int64",
2585
+ "name": "BatchSize",
2586
+ "required": false,
2587
+ "type": "int"
2588
+ },
2589
+ {
2590
+ "disabled": false,
2591
+ "document": "重启节点",
2592
+ "example": "[ip1,ip2]",
2593
+ "member": "string",
2594
+ "name": "NodeList",
2595
+ "required": false,
2596
+ "type": "list"
2597
+ },
2598
+ {
2599
+ "disabled": false,
2600
+ "document": "false表示非滚动重启，true表示滚动重启",
2601
+ "example": "无",
2602
+ "member": "bool",
2603
+ "name": "RollingRestart",
2604
+ "required": false,
2605
+ "type": "bool"
2606
+ }
2607
+ ],
2608
+ "type": "object"
2609
+ },
2610
+ "RestartClusterForNodeResponse": {
2611
+ "document": "RestartClusterForNode返回参数结构体",
2612
+ "members": [
2613
+ {
2614
+ "disabled": false,
2615
+ "document": "流程相关信息",
2616
+ "example": "-",
2617
+ "member": "int64",
2618
+ "name": "FlowId",
2619
+ "output_required": true,
691
2620
  "type": "int",
692
- "value_allowed_null": true
2621
+ "value_allowed_null": false
2622
+ },
2623
+ {
2624
+ "disabled": false,
2625
+ "document": "错误信息",
2626
+ "example": "-",
2627
+ "member": "string",
2628
+ "name": "ErrorMsg",
2629
+ "output_required": true,
2630
+ "type": "string",
2631
+ "value_allowed_null": false
2632
+ },
2633
+ {
2634
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2635
+ "member": "string",
2636
+ "name": "RequestId",
2637
+ "type": "string"
2638
+ }
2639
+ ],
2640
+ "type": "object"
2641
+ },
2642
+ "ScaleOutInstanceRequest": {
2643
+ "document": "ScaleOutInstance请求参数结构体",
2644
+ "members": [
2645
+ {
2646
+ "disabled": false,
2647
+ "document": "集群ID",
2648
+ "example": "无",
2649
+ "member": "string",
2650
+ "name": "InstanceId",
2651
+ "required": true,
2652
+ "type": "string"
2653
+ },
2654
+ {
2655
+ "disabled": false,
2656
+ "document": "角色（MATER/CORE），MASTER 对应 FE，CORE对应BE",
2657
+ "example": "无",
2658
+ "member": "string",
2659
+ "name": "Type",
2660
+ "required": true,
2661
+ "type": "string"
2662
+ },
2663
+ {
2664
+ "disabled": false,
2665
+ "document": "节点数量",
2666
+ "example": "无",
2667
+ "member": "uint64",
2668
+ "name": "NodeCount",
2669
+ "required": true,
2670
+ "type": "int"
2671
+ },
2672
+ {
2673
+ "disabled": false,
2674
+ "document": "扩容后集群高可用类型：0：非高可用，1：读高可用，2：读写高可用。",
2675
+ "example": "0",
2676
+ "member": "int64",
2677
+ "name": "HaType",
2678
+ "required": false,
2679
+ "type": "int"
693
2680
  }
694
2681
  ],
695
- "usage": "out"
2682
+ "type": "object"
696
2683
  },
697
- "InstanceNode": {
698
- "document": "实例节点描述信息",
2684
+ "ScaleOutInstanceResponse": {
2685
+ "document": "ScaleOutInstance返回参数结构体",
699
2686
  "members": [
700
2687
  {
701
2688
  "disabled": false,
702
- "document": "IP地址",
703
- "example": "10.0.0.1",
2689
+ "document": "流程ID",
2690
+ "example": "无",
704
2691
  "member": "string",
705
- "name": "Ip",
706
- "output_required": true,
2692
+ "name": "FlowId",
2693
+ "output_required": false,
707
2694
  "type": "string",
708
2695
  "value_allowed_null": false
709
2696
  },
710
2697
  {
711
2698
  "disabled": false,
712
- "document": "机型，如 S1",
713
- "example": "SCH1",
2699
+ "document": "集群ID",
2700
+ "example": "无",
714
2701
  "member": "string",
715
- "name": "Spec",
716
- "output_required": true,
2702
+ "name": "InstanceId",
2703
+ "output_required": false,
717
2704
  "type": "string",
718
2705
  "value_allowed_null": false
719
2706
  },
720
2707
  {
721
2708
  "disabled": false,
722
- "document": "cpu核数",
723
- "example": "2",
724
- "member": "int64",
725
- "name": "Core",
726
- "output_required": true,
727
- "type": "int",
2709
+ "document": "错误信息",
2710
+ "example": "无",
2711
+ "member": "string",
2712
+ "name": "ErrorMsg",
2713
+ "output_required": false,
2714
+ "type": "string",
728
2715
  "value_allowed_null": false
729
2716
  },
730
2717
  {
731
- "disabled": false,
732
- "document": "内存大小",
733
- "example": "4",
734
- "member": "int64",
735
- "name": "Memory",
736
- "output_required": true,
737
- "type": "int",
738
- "value_allowed_null": false
739
- },
2718
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2719
+ "member": "string",
2720
+ "name": "RequestId",
2721
+ "type": "string"
2722
+ }
2723
+ ],
2724
+ "type": "object"
2725
+ },
2726
+ "ScaleUpInstanceRequest": {
2727
+ "document": "ScaleUpInstance请求参数结构体",
2728
+ "members": [
740
2729
  {
741
2730
  "disabled": false,
742
- "document": "磁盘类型",
743
- "example": "CLOUD_HSSD",
2731
+ "document": "集群ID",
2732
+ "example": "无",
744
2733
  "member": "string",
745
- "name": "DiskType",
746
- "output_required": true,
747
- "type": "string",
748
- "value_allowed_null": false
2734
+ "name": "InstanceId",
2735
+ "required": true,
2736
+ "type": "string"
749
2737
  },
750
2738
  {
751
2739
  "disabled": false,
752
- "document": "磁盘大小",
753
- "example": "100",
754
- "member": "int64",
755
- "name": "DiskSize",
756
- "output_required": true,
757
- "type": "int",
758
- "value_allowed_null": false
2740
+ "document": "节点规格",
2741
+ "example": "无",
2742
+ "member": "string",
2743
+ "name": "SpecName",
2744
+ "required": true,
2745
+ "type": "string"
759
2746
  },
760
2747
  {
761
2748
  "disabled": false,
762
- "document": "所属clickhouse cluster名称",
763
- "example": "default_cluster",
2749
+ "document": "角色（MATER/CORE），MASTER 对应 FE，CORE对应BE",
2750
+ "example": "无",
764
2751
  "member": "string",
765
- "name": "Role",
766
- "output_required": true,
767
- "type": "string",
768
- "value_allowed_null": false
769
- },
2752
+ "name": "Type",
2753
+ "required": true,
2754
+ "type": "string"
2755
+ }
2756
+ ],
2757
+ "type": "object"
2758
+ },
2759
+ "ScaleUpInstanceResponse": {
2760
+ "document": "ScaleUpInstance返回参数结构体",
2761
+ "members": [
770
2762
  {
771
2763
  "disabled": false,
772
- "document": "状态\n注意：此字段可能返回 null，表示取不到有效值。",
2764
+ "document": "流程ID",
773
2765
  "example": "无",
774
2766
  "member": "string",
775
- "name": "Status",
2767
+ "name": "FlowId",
776
2768
  "output_required": false,
777
2769
  "type": "string",
778
- "value_allowed_null": true
2770
+ "value_allowed_null": false
779
2771
  },
780
2772
  {
781
2773
  "disabled": false,
782
- "document": "rip\n注意：此字段可能返回 null，表示取不到有效值。",
2774
+ "document": "实例ID",
783
2775
  "example": "无",
784
2776
  "member": "string",
785
- "name": "Rip",
2777
+ "name": "InstanceId",
786
2778
  "output_required": false,
787
2779
  "type": "string",
788
- "value_allowed_null": true
2780
+ "value_allowed_null": false
789
2781
  },
790
2782
  {
791
2783
  "disabled": false,
792
- "document": "FE节点角色\n注意：此字段可能返回 null，表示取不到有效值。",
793
- "example": "leader",
2784
+ "document": "错误信息",
2785
+ "example": "无",
794
2786
  "member": "string",
795
- "name": "FeRole",
2787
+ "name": "ErrorMsg",
796
2788
  "output_required": false,
797
2789
  "type": "string",
798
- "value_allowed_null": true
2790
+ "value_allowed_null": false
799
2791
  },
800
2792
  {
801
- "disabled": false,
802
- "document": "UUID\n注意：此字段可能返回 null，表示取不到有效值。",
803
- "example": "2e8ed58d-bbf8-48f2-bfa6-3c5b3f4b9xas",
2793
+ "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
804
2794
  "member": "string",
805
- "name": "UUID",
806
- "output_required": false,
807
- "type": "string",
808
- "value_allowed_null": true
2795
+ "name": "RequestId",
2796
+ "type": "string"
809
2797
  }
810
2798
  ],
811
- "usage": "out"
2799
+ "type": "object"
812
2800
  },
813
- "NodesSummary": {
814
- "document": "节点角色描述信息",
2801
+ "SearchTags": {
2802
+ "document": "列表页搜索的标记列表",
815
2803
  "members": [
816
2804
  {
817
2805
  "disabled": false,
818
- "document": "机型，如 S1",
819
- "example": "xx",
2806
+ "document": "标签的键",
2807
+ "example": "标签一",
820
2808
  "member": "string",
821
- "name": "Spec",
822
- "output_required": true,
2809
+ "name": "TagKey",
2810
+ "required": false,
823
2811
  "type": "string",
824
2812
  "value_allowed_null": false
825
2813
  },
826
2814
  {
827
2815
  "disabled": false,
828
- "document": "节点数目",
829
- "example": "1",
830
- "member": "int64",
831
- "name": "NodeSize",
832
- "output_required": true,
833
- "type": "int",
834
- "value_allowed_null": false
835
- },
836
- {
837
- "disabled": false,
838
- "document": "cpu核数，单位个",
839
- "example": "2",
840
- "member": "int64",
841
- "name": "Core",
842
- "output_required": true,
843
- "type": "int",
2816
+ "document": "标签的值",
2817
+ "example": "标签值一",
2818
+ "member": "string",
2819
+ "name": "TagValue",
2820
+ "required": false,
2821
+ "type": "string",
844
2822
  "value_allowed_null": false
845
2823
  },
846
2824
  {
847
2825
  "disabled": false,
848
- "document": "内存大小，单位G",
849
- "example": "4",
2826
+ "document": "1表示只输入标签的键，没有输入值；0表示输入键时且输入值",
2827
+ "example": "1",
850
2828
  "member": "int64",
851
- "name": "Memory",
852
- "output_required": true,
2829
+ "name": "AllValue",
2830
+ "required": false,
853
2831
  "type": "int",
854
2832
  "value_allowed_null": false
855
- },
2833
+ }
2834
+ ],
2835
+ "usage": "in"
2836
+ },
2837
+ "SlowQueryRecord": {
2838
+ "document": "慢查询记录",
2839
+ "members": [
856
2840
  {
857
2841
  "disabled": false,
858
- "document": "磁盘大小，单位G",
2842
+ "document": "查询用户",
859
2843
  "example": "xx",
860
- "member": "int64",
861
- "name": "Disk",
2844
+ "member": "string",
2845
+ "name": "OsUser",
862
2846
  "output_required": true,
863
- "type": "int",
2847
+ "type": "string",
864
2848
  "value_allowed_null": false
865
2849
  },
866
2850
  {
867
2851
  "disabled": false,
868
- "document": "磁盘类型",
2852
+ "document": "查询ID",
869
2853
  "example": "xx",
870
2854
  "member": "string",
871
- "name": "DiskType",
2855
+ "name": "InitialQueryId",
872
2856
  "output_required": true,
873
2857
  "type": "string",
874
2858
  "value_allowed_null": false
875
2859
  },
876
2860
  {
877
2861
  "disabled": false,
878
- "document": "磁盘描述",
2862
+ "document": "SQL语句",
879
2863
  "example": "xx",
880
2864
  "member": "string",
881
- "name": "DiskDesc",
2865
+ "name": "Sql",
882
2866
  "output_required": true,
883
2867
  "type": "string",
884
2868
  "value_allowed_null": false
885
2869
  },
886
2870
  {
887
2871
  "disabled": false,
888
- "document": "挂载云盘信息\n注意：此字段可能返回 null，表示取不到有效值。",
2872
+ "document": "开始时间",
889
2873
  "example": "xx",
890
- "member": "AttachCBSSpec",
891
- "name": "AttachCBSSpec",
892
- "output_required": true,
893
- "type": "object",
894
- "value_allowed_null": true
895
- },
896
- {
897
- "disabled": false,
898
- "document": "子产品名称\n注意：此字段可能返回 null，表示取不到有效值。",
899
- "example": "cdwdoris",
900
2874
  "member": "string",
901
- "name": "SubProductType",
902
- "output_required": false,
2875
+ "name": "QueryStartTime",
2876
+ "output_required": true,
903
2877
  "type": "string",
904
- "value_allowed_null": true
2878
+ "value_allowed_null": false
905
2879
  },
906
2880
  {
907
2881
  "disabled": false,
908
- "document": "规格核数\n注意：此字段可能返回 null，表示取不到有效值。",
909
- "example": "无",
2882
+ "document": "执行耗时",
2883
+ "example": "xx",
910
2884
  "member": "int64",
911
- "name": "SpecCore",
912
- "output_required": false,
2885
+ "name": "DurationMs",
2886
+ "output_required": true,
913
2887
  "type": "int",
914
- "value_allowed_null": true
2888
+ "value_allowed_null": false
915
2889
  },
916
2890
  {
917
2891
  "disabled": false,
918
- "document": "规格内存\n注意：此字段可能返回 null，表示取不到有效值。",
919
- "example": "无",
2892
+ "document": "读取行数",
2893
+ "example": "xx",
920
2894
  "member": "int64",
921
- "name": "SpecMemory",
922
- "output_required": false,
2895
+ "name": "ReadRows",
2896
+ "output_required": true,
923
2897
  "type": "int",
924
- "value_allowed_null": true
2898
+ "value_allowed_null": false
925
2899
  },
926
2900
  {
927
2901
  "disabled": false,
928
- "document": "磁盘大小\n注意：此字段可能返回 null，表示取不到有效值。",
929
- "example": "无",
2902
+ "document": "读取字节数",
2903
+ "example": "xx",
930
2904
  "member": "int64",
931
- "name": "DiskCount",
932
- "output_required": false,
2905
+ "name": "ResultRows",
2906
+ "output_required": true,
933
2907
  "type": "int",
934
- "value_allowed_null": true
2908
+ "value_allowed_null": false
935
2909
  },
936
2910
  {
937
2911
  "disabled": false,
938
- "document": "是否加密\n注意：此字段可能返回 null，表示取不到有效值。",
939
- "example": "无",
940
- "member": "int64",
941
- "name": "Encrypt",
942
- "output_required": false,
2912
+ "document": "结果字节数",
2913
+ "example": "xx",
2914
+ "member": "uint64",
2915
+ "name": "ResultBytes",
2916
+ "output_required": true,
943
2917
  "type": "int",
944
- "value_allowed_null": true
2918
+ "value_allowed_null": false
945
2919
  },
946
2920
  {
947
2921
  "disabled": false,
948
- "document": "最大磁盘\n注意：此字段可能返回 null，表示取不到有效值。",
949
- "example": "无",
2922
+ "document": "内存",
2923
+ "example": "xx",
950
2924
  "member": "int64",
951
- "name": "MaxDiskSize",
952
- "output_required": false,
2925
+ "name": "MemoryUsage",
2926
+ "output_required": true,
953
2927
  "type": "int",
954
- "value_allowed_null": true
955
- }
956
- ],
957
- "usage": "out"
958
- },
959
- "SearchTags": {
960
- "document": "列表页搜索的标记列表",
961
- "members": [
2928
+ "value_allowed_null": false
2929
+ },
962
2930
  {
963
2931
  "disabled": false,
964
- "document": "标签的键",
965
- "example": "标签一",
2932
+ "document": "初始查询IP",
2933
+ "example": "xx",
966
2934
  "member": "string",
967
- "name": "TagKey",
968
- "required": false,
2935
+ "name": "InitialAddress",
2936
+ "output_required": true,
969
2937
  "type": "string",
970
2938
  "value_allowed_null": false
971
2939
  },
972
2940
  {
973
2941
  "disabled": false,
974
- "document": "标签的值",
975
- "example": "标签值一",
2942
+ "document": "数据库名\n注意：此字段可能返回 null，表示取不到有效值。",
2943
+ "example": "xx",
976
2944
  "member": "string",
977
- "name": "TagValue",
978
- "required": false,
2945
+ "name": "DbName",
2946
+ "output_required": false,
979
2947
  "type": "string",
980
- "value_allowed_null": false
2948
+ "value_allowed_null": true
981
2949
  },
982
2950
  {
983
2951
  "disabled": false,
984
- "document": "1表示只输入标签的键，没有输入值；0表示输入键时且输入值",
2952
+ "document": "是否是查询，0：否，1：查询语句\n注意：此字段可能返回 null，表示取不到有效值。",
985
2953
  "example": "1",
986
2954
  "member": "int64",
987
- "name": "AllValue",
988
- "required": false,
2955
+ "name": "IsQuery",
2956
+ "output_required": false,
989
2957
  "type": "int",
990
- "value_allowed_null": false
2958
+ "value_allowed_null": true
991
2959
  }
992
2960
  ],
993
- "usage": "in"
2961
+ "usage": "out"
994
2962
  },
995
2963
  "Tag": {
996
2964
  "document": "标签描述",