tencentcloud-sdk-tat 1.0.200
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/VERSION +1 -0
- data/lib/tencentcloud-sdk-tat.rb +11 -0
- data/lib/v20201028/client.rb +482 -0
- data/lib/v20201028/models.rb +1685 -0
- metadata +66 -0
@@ -0,0 +1,1685 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module TencentCloud
|
18
|
+
module Tat
|
19
|
+
module V20201028
|
20
|
+
# 自动化助手客户端信息
|
21
|
+
class AutomationAgentInfo < TencentCloud::Common::AbstractModel
|
22
|
+
# @param InstanceId: 实例ID。
|
23
|
+
# @type InstanceId: String
|
24
|
+
# @param Version: Agent 版本号。
|
25
|
+
# @type Version: String
|
26
|
+
# @param LastHeartbeatTime: 上次心跳时间
|
27
|
+
# @type LastHeartbeatTime: String
|
28
|
+
# @param AgentStatus: Agent状态,取值范围:
|
29
|
+
# <li> Online:在线
|
30
|
+
# <li> Offline:离线
|
31
|
+
# @type AgentStatus: String
|
32
|
+
# @param Environment: Agent运行环境,取值范围:
|
33
|
+
# <li> Linux:Linux实例
|
34
|
+
# <li> Windows:Windows实例
|
35
|
+
# @type Environment: String
|
36
|
+
|
37
|
+
attr_accessor :InstanceId, :Version, :LastHeartbeatTime, :AgentStatus, :Environment
|
38
|
+
|
39
|
+
def initialize(instanceid=nil, version=nil, lastheartbeattime=nil, agentstatus=nil, environment=nil)
|
40
|
+
@InstanceId = instanceid
|
41
|
+
@Version = version
|
42
|
+
@LastHeartbeatTime = lastheartbeattime
|
43
|
+
@AgentStatus = agentstatus
|
44
|
+
@Environment = environment
|
45
|
+
end
|
46
|
+
|
47
|
+
def deserialize(params)
|
48
|
+
@InstanceId = params['InstanceId']
|
49
|
+
@Version = params['Version']
|
50
|
+
@LastHeartbeatTime = params['LastHeartbeatTime']
|
51
|
+
@AgentStatus = params['AgentStatus']
|
52
|
+
@Environment = params['Environment']
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
# 命令详情。
|
57
|
+
class Command < TencentCloud::Common::AbstractModel
|
58
|
+
# @param CommandId: 命令ID。
|
59
|
+
# @type CommandId: String
|
60
|
+
# @param CommandName: 命令名称。
|
61
|
+
# @type CommandName: String
|
62
|
+
# @param Description: 命令描述。
|
63
|
+
# @type Description: String
|
64
|
+
# @param Content: Base64编码后的命令内容。
|
65
|
+
# @type Content: String
|
66
|
+
# @param CommandType: 命令类型。
|
67
|
+
# @type CommandType: String
|
68
|
+
# @param WorkingDirectory: 命令执行路径。
|
69
|
+
# @type WorkingDirectory: String
|
70
|
+
# @param Timeout: 命令超时时间。
|
71
|
+
# @type Timeout: Integer
|
72
|
+
# @param CreatedTime: 命令创建时间。
|
73
|
+
# @type CreatedTime: String
|
74
|
+
# @param UpdatedTime: 命令更新时间。
|
75
|
+
# @type UpdatedTime: String
|
76
|
+
# @param EnableParameter: 是否启用自定义参数功能。
|
77
|
+
# @type EnableParameter: Boolean
|
78
|
+
# @param DefaultParameters: 自定义参数的默认取值。
|
79
|
+
# @type DefaultParameters: String
|
80
|
+
# @param FormattedDescription: 命令的结构化描述。公共命令有值,用户命令为空字符串。
|
81
|
+
# @type FormattedDescription: String
|
82
|
+
# @param CreatedBy: 命令创建者。TAT 代表公共命令,USER 代表个人命令。
|
83
|
+
# @type CreatedBy: String
|
84
|
+
# @param Tags: 命令关联的标签列表。
|
85
|
+
# @type Tags: Array
|
86
|
+
# @param Username: 在实例上执行命令的用户名。
|
87
|
+
# @type Username: String
|
88
|
+
|
89
|
+
attr_accessor :CommandId, :CommandName, :Description, :Content, :CommandType, :WorkingDirectory, :Timeout, :CreatedTime, :UpdatedTime, :EnableParameter, :DefaultParameters, :FormattedDescription, :CreatedBy, :Tags, :Username
|
90
|
+
|
91
|
+
def initialize(commandid=nil, commandname=nil, description=nil, content=nil, commandtype=nil, workingdirectory=nil, timeout=nil, createdtime=nil, updatedtime=nil, enableparameter=nil, defaultparameters=nil, formatteddescription=nil, createdby=nil, tags=nil, username=nil)
|
92
|
+
@CommandId = commandid
|
93
|
+
@CommandName = commandname
|
94
|
+
@Description = description
|
95
|
+
@Content = content
|
96
|
+
@CommandType = commandtype
|
97
|
+
@WorkingDirectory = workingdirectory
|
98
|
+
@Timeout = timeout
|
99
|
+
@CreatedTime = createdtime
|
100
|
+
@UpdatedTime = updatedtime
|
101
|
+
@EnableParameter = enableparameter
|
102
|
+
@DefaultParameters = defaultparameters
|
103
|
+
@FormattedDescription = formatteddescription
|
104
|
+
@CreatedBy = createdby
|
105
|
+
@Tags = tags
|
106
|
+
@Username = username
|
107
|
+
end
|
108
|
+
|
109
|
+
def deserialize(params)
|
110
|
+
@CommandId = params['CommandId']
|
111
|
+
@CommandName = params['CommandName']
|
112
|
+
@Description = params['Description']
|
113
|
+
@Content = params['Content']
|
114
|
+
@CommandType = params['CommandType']
|
115
|
+
@WorkingDirectory = params['WorkingDirectory']
|
116
|
+
@Timeout = params['Timeout']
|
117
|
+
@CreatedTime = params['CreatedTime']
|
118
|
+
@UpdatedTime = params['UpdatedTime']
|
119
|
+
@EnableParameter = params['EnableParameter']
|
120
|
+
@DefaultParameters = params['DefaultParameters']
|
121
|
+
@FormattedDescription = params['FormattedDescription']
|
122
|
+
@CreatedBy = params['CreatedBy']
|
123
|
+
unless params['Tags'].nil?
|
124
|
+
@Tags = []
|
125
|
+
params['Tags'].each do |i|
|
126
|
+
tag_tmp = Tag.new
|
127
|
+
tag_tmp.deserialize(i)
|
128
|
+
@Tags << tag_tmp
|
129
|
+
end
|
130
|
+
end
|
131
|
+
@Username = params['Username']
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
# 命令执行详情。
|
136
|
+
class CommandDocument < TencentCloud::Common::AbstractModel
|
137
|
+
# @param Content: Base64 编码后的执行命令。
|
138
|
+
# @type Content: String
|
139
|
+
# @param CommandType: 命令类型。
|
140
|
+
# @type CommandType: String
|
141
|
+
# @param Timeout: 超时时间。
|
142
|
+
# @type Timeout: Integer
|
143
|
+
# @param WorkingDirectory: 执行路径。
|
144
|
+
# @type WorkingDirectory: String
|
145
|
+
# @param Username: 执行用户。
|
146
|
+
# @type Username: String
|
147
|
+
|
148
|
+
attr_accessor :Content, :CommandType, :Timeout, :WorkingDirectory, :Username
|
149
|
+
|
150
|
+
def initialize(content=nil, commandtype=nil, timeout=nil, workingdirectory=nil, username=nil)
|
151
|
+
@Content = content
|
152
|
+
@CommandType = commandtype
|
153
|
+
@Timeout = timeout
|
154
|
+
@WorkingDirectory = workingdirectory
|
155
|
+
@Username = username
|
156
|
+
end
|
157
|
+
|
158
|
+
def deserialize(params)
|
159
|
+
@Content = params['Content']
|
160
|
+
@CommandType = params['CommandType']
|
161
|
+
@Timeout = params['Timeout']
|
162
|
+
@WorkingDirectory = params['WorkingDirectory']
|
163
|
+
@Username = params['Username']
|
164
|
+
end
|
165
|
+
end
|
166
|
+
|
167
|
+
# CreateCommand请求参数结构体
|
168
|
+
class CreateCommandRequest < TencentCloud::Common::AbstractModel
|
169
|
+
# @param CommandName: 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
|
170
|
+
# @type CommandName: String
|
171
|
+
# @param Content: Base64编码后的命令内容,长度不可超过64KB。
|
172
|
+
# @type Content: String
|
173
|
+
# @param Description: 命令描述。不超过120字符。
|
174
|
+
# @type Description: String
|
175
|
+
# @param CommandType: 命令类型,目前仅支持取值:SHELL。默认:SHELL。
|
176
|
+
# @type CommandType: String
|
177
|
+
# @param WorkingDirectory: 命令执行路径,默认:/root。
|
178
|
+
# @type WorkingDirectory: String
|
179
|
+
# @param Timeout: 命令超时时间,默认60秒。取值范围[1, 86400]。
|
180
|
+
# @type Timeout: Integer
|
181
|
+
# @param EnableParameter: 是否启用自定义参数功能。
|
182
|
+
# 一旦创建,此值不提供修改。
|
183
|
+
# 默认值:false。
|
184
|
+
# @type EnableParameter: Boolean
|
185
|
+
# @param DefaultParameters: 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。
|
186
|
+
# key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
187
|
+
# 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
|
188
|
+
# 自定义参数最多20个。
|
189
|
+
# 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
190
|
+
# @type DefaultParameters: String
|
191
|
+
# @param Tags: 为命令关联的标签,列表长度不超过10。
|
192
|
+
# @type Tags: Array
|
193
|
+
# @param Username: 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
|
194
|
+
# 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在Linux实例中以root用户执行命令。
|
195
|
+
# @type Username: String
|
196
|
+
|
197
|
+
attr_accessor :CommandName, :Content, :Description, :CommandType, :WorkingDirectory, :Timeout, :EnableParameter, :DefaultParameters, :Tags, :Username
|
198
|
+
|
199
|
+
def initialize(commandname=nil, content=nil, description=nil, commandtype=nil, workingdirectory=nil, timeout=nil, enableparameter=nil, defaultparameters=nil, tags=nil, username=nil)
|
200
|
+
@CommandName = commandname
|
201
|
+
@Content = content
|
202
|
+
@Description = description
|
203
|
+
@CommandType = commandtype
|
204
|
+
@WorkingDirectory = workingdirectory
|
205
|
+
@Timeout = timeout
|
206
|
+
@EnableParameter = enableparameter
|
207
|
+
@DefaultParameters = defaultparameters
|
208
|
+
@Tags = tags
|
209
|
+
@Username = username
|
210
|
+
end
|
211
|
+
|
212
|
+
def deserialize(params)
|
213
|
+
@CommandName = params['CommandName']
|
214
|
+
@Content = params['Content']
|
215
|
+
@Description = params['Description']
|
216
|
+
@CommandType = params['CommandType']
|
217
|
+
@WorkingDirectory = params['WorkingDirectory']
|
218
|
+
@Timeout = params['Timeout']
|
219
|
+
@EnableParameter = params['EnableParameter']
|
220
|
+
@DefaultParameters = params['DefaultParameters']
|
221
|
+
unless params['Tags'].nil?
|
222
|
+
@Tags = []
|
223
|
+
params['Tags'].each do |i|
|
224
|
+
tag_tmp = Tag.new
|
225
|
+
tag_tmp.deserialize(i)
|
226
|
+
@Tags << tag_tmp
|
227
|
+
end
|
228
|
+
end
|
229
|
+
@Username = params['Username']
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
233
|
+
# CreateCommand返回参数结构体
|
234
|
+
class CreateCommandResponse < TencentCloud::Common::AbstractModel
|
235
|
+
# @param CommandId: 命令ID。
|
236
|
+
# @type CommandId: String
|
237
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
238
|
+
# @type RequestId: String
|
239
|
+
|
240
|
+
attr_accessor :CommandId, :RequestId
|
241
|
+
|
242
|
+
def initialize(commandid=nil, requestid=nil)
|
243
|
+
@CommandId = commandid
|
244
|
+
@RequestId = requestid
|
245
|
+
end
|
246
|
+
|
247
|
+
def deserialize(params)
|
248
|
+
@CommandId = params['CommandId']
|
249
|
+
@RequestId = params['RequestId']
|
250
|
+
end
|
251
|
+
end
|
252
|
+
|
253
|
+
# CreateInvoker请求参数结构体
|
254
|
+
class CreateInvokerRequest < TencentCloud::Common::AbstractModel
|
255
|
+
# @param Name: 执行器名称。
|
256
|
+
# @type Name: String
|
257
|
+
# @param Type: 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
|
258
|
+
# @type Type: String
|
259
|
+
# @param CommandId: 远程命令ID。
|
260
|
+
# @type CommandId: String
|
261
|
+
# @param InstanceIds: 触发器关联的实例ID。列表上限 100。
|
262
|
+
# @type InstanceIds: Array
|
263
|
+
# @param Username: 命令执行用户。
|
264
|
+
# @type Username: String
|
265
|
+
# @param Parameters: 命令自定义参数。
|
266
|
+
# @type Parameters: String
|
267
|
+
# @param ScheduleSettings: 周期执行器设置,当创建周期执行器时,必须指定此参数。
|
268
|
+
# @type ScheduleSettings: :class:`Tencentcloud::Tat.v20201028.models.ScheduleSettings`
|
269
|
+
|
270
|
+
attr_accessor :Name, :Type, :CommandId, :InstanceIds, :Username, :Parameters, :ScheduleSettings
|
271
|
+
|
272
|
+
def initialize(name=nil, type=nil, commandid=nil, instanceids=nil, username=nil, parameters=nil, schedulesettings=nil)
|
273
|
+
@Name = name
|
274
|
+
@Type = type
|
275
|
+
@CommandId = commandid
|
276
|
+
@InstanceIds = instanceids
|
277
|
+
@Username = username
|
278
|
+
@Parameters = parameters
|
279
|
+
@ScheduleSettings = schedulesettings
|
280
|
+
end
|
281
|
+
|
282
|
+
def deserialize(params)
|
283
|
+
@Name = params['Name']
|
284
|
+
@Type = params['Type']
|
285
|
+
@CommandId = params['CommandId']
|
286
|
+
@InstanceIds = params['InstanceIds']
|
287
|
+
@Username = params['Username']
|
288
|
+
@Parameters = params['Parameters']
|
289
|
+
unless params['ScheduleSettings'].nil?
|
290
|
+
@ScheduleSettings = ScheduleSettings.new
|
291
|
+
@ScheduleSettings.deserialize(params['ScheduleSettings'])
|
292
|
+
end
|
293
|
+
end
|
294
|
+
end
|
295
|
+
|
296
|
+
# CreateInvoker返回参数结构体
|
297
|
+
class CreateInvokerResponse < TencentCloud::Common::AbstractModel
|
298
|
+
# @param InvokerId: 执行器ID。
|
299
|
+
# @type InvokerId: String
|
300
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
301
|
+
# @type RequestId: String
|
302
|
+
|
303
|
+
attr_accessor :InvokerId, :RequestId
|
304
|
+
|
305
|
+
def initialize(invokerid=nil, requestid=nil)
|
306
|
+
@InvokerId = invokerid
|
307
|
+
@RequestId = requestid
|
308
|
+
end
|
309
|
+
|
310
|
+
def deserialize(params)
|
311
|
+
@InvokerId = params['InvokerId']
|
312
|
+
@RequestId = params['RequestId']
|
313
|
+
end
|
314
|
+
end
|
315
|
+
|
316
|
+
# DeleteCommand请求参数结构体
|
317
|
+
class DeleteCommandRequest < TencentCloud::Common::AbstractModel
|
318
|
+
# @param CommandId: 待删除的命令ID。
|
319
|
+
# @type CommandId: String
|
320
|
+
|
321
|
+
attr_accessor :CommandId
|
322
|
+
|
323
|
+
def initialize(commandid=nil)
|
324
|
+
@CommandId = commandid
|
325
|
+
end
|
326
|
+
|
327
|
+
def deserialize(params)
|
328
|
+
@CommandId = params['CommandId']
|
329
|
+
end
|
330
|
+
end
|
331
|
+
|
332
|
+
# DeleteCommand返回参数结构体
|
333
|
+
class DeleteCommandResponse < TencentCloud::Common::AbstractModel
|
334
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
335
|
+
# @type RequestId: String
|
336
|
+
|
337
|
+
attr_accessor :RequestId
|
338
|
+
|
339
|
+
def initialize(requestid=nil)
|
340
|
+
@RequestId = requestid
|
341
|
+
end
|
342
|
+
|
343
|
+
def deserialize(params)
|
344
|
+
@RequestId = params['RequestId']
|
345
|
+
end
|
346
|
+
end
|
347
|
+
|
348
|
+
# DeleteInvoker请求参数结构体
|
349
|
+
class DeleteInvokerRequest < TencentCloud::Common::AbstractModel
|
350
|
+
# @param InvokerId: 待删除的执行器ID。
|
351
|
+
# @type InvokerId: String
|
352
|
+
|
353
|
+
attr_accessor :InvokerId
|
354
|
+
|
355
|
+
def initialize(invokerid=nil)
|
356
|
+
@InvokerId = invokerid
|
357
|
+
end
|
358
|
+
|
359
|
+
def deserialize(params)
|
360
|
+
@InvokerId = params['InvokerId']
|
361
|
+
end
|
362
|
+
end
|
363
|
+
|
364
|
+
# DeleteInvoker返回参数结构体
|
365
|
+
class DeleteInvokerResponse < TencentCloud::Common::AbstractModel
|
366
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
367
|
+
# @type RequestId: String
|
368
|
+
|
369
|
+
attr_accessor :RequestId
|
370
|
+
|
371
|
+
def initialize(requestid=nil)
|
372
|
+
@RequestId = requestid
|
373
|
+
end
|
374
|
+
|
375
|
+
def deserialize(params)
|
376
|
+
@RequestId = params['RequestId']
|
377
|
+
end
|
378
|
+
end
|
379
|
+
|
380
|
+
# DescribeAutomationAgentStatus请求参数结构体
|
381
|
+
class DescribeAutomationAgentStatusRequest < TencentCloud::Common::AbstractModel
|
382
|
+
# @param InstanceIds: 待查询的实例ID列表。
|
383
|
+
# @type InstanceIds: Array
|
384
|
+
# @param Filters: 过滤条件。<br> <li> agent-status - String - 是否必填:否 -(过滤条件)按照agent状态过滤,取值:Online 在线,Offline 离线。<br> <li> environment - String - 是否必填:否 -(过滤条件)按照agent运行环境查询,取值:Linux。<br> <li> instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InstanceIds` 和 `Filters` 。
|
385
|
+
# @type Filters: Array
|
386
|
+
# @param Limit: 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
387
|
+
# @type Limit: Integer
|
388
|
+
# @param Offset: 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
389
|
+
# @type Offset: Integer
|
390
|
+
|
391
|
+
attr_accessor :InstanceIds, :Filters, :Limit, :Offset
|
392
|
+
|
393
|
+
def initialize(instanceids=nil, filters=nil, limit=nil, offset=nil)
|
394
|
+
@InstanceIds = instanceids
|
395
|
+
@Filters = filters
|
396
|
+
@Limit = limit
|
397
|
+
@Offset = offset
|
398
|
+
end
|
399
|
+
|
400
|
+
def deserialize(params)
|
401
|
+
@InstanceIds = params['InstanceIds']
|
402
|
+
unless params['Filters'].nil?
|
403
|
+
@Filters = []
|
404
|
+
params['Filters'].each do |i|
|
405
|
+
filter_tmp = Filter.new
|
406
|
+
filter_tmp.deserialize(i)
|
407
|
+
@Filters << filter_tmp
|
408
|
+
end
|
409
|
+
end
|
410
|
+
@Limit = params['Limit']
|
411
|
+
@Offset = params['Offset']
|
412
|
+
end
|
413
|
+
end
|
414
|
+
|
415
|
+
# DescribeAutomationAgentStatus返回参数结构体
|
416
|
+
class DescribeAutomationAgentStatusResponse < TencentCloud::Common::AbstractModel
|
417
|
+
# @param AutomationAgentSet: Agent 信息列表。
|
418
|
+
# @type AutomationAgentSet: Array
|
419
|
+
# @param TotalCount: 符合条件的 Agent 总数。
|
420
|
+
# @type TotalCount: Integer
|
421
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
422
|
+
# @type RequestId: String
|
423
|
+
|
424
|
+
attr_accessor :AutomationAgentSet, :TotalCount, :RequestId
|
425
|
+
|
426
|
+
def initialize(automationagentset=nil, totalcount=nil, requestid=nil)
|
427
|
+
@AutomationAgentSet = automationagentset
|
428
|
+
@TotalCount = totalcount
|
429
|
+
@RequestId = requestid
|
430
|
+
end
|
431
|
+
|
432
|
+
def deserialize(params)
|
433
|
+
unless params['AutomationAgentSet'].nil?
|
434
|
+
@AutomationAgentSet = []
|
435
|
+
params['AutomationAgentSet'].each do |i|
|
436
|
+
automationagentinfo_tmp = AutomationAgentInfo.new
|
437
|
+
automationagentinfo_tmp.deserialize(i)
|
438
|
+
@AutomationAgentSet << automationagentinfo_tmp
|
439
|
+
end
|
440
|
+
end
|
441
|
+
@TotalCount = params['TotalCount']
|
442
|
+
@RequestId = params['RequestId']
|
443
|
+
end
|
444
|
+
end
|
445
|
+
|
446
|
+
# DescribeCommands请求参数结构体
|
447
|
+
class DescribeCommandsRequest < TencentCloud::Common::AbstractModel
|
448
|
+
# @param CommandIds: 命令ID列表,每次请求的上限为100。参数不支持同时指定 `CommandIds` 和 `Filters` 。
|
449
|
+
# @type CommandIds: Array
|
450
|
+
# @param Filters: 过滤条件。
|
451
|
+
# <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。
|
452
|
+
# <li> command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。
|
453
|
+
# <li> command-type - String - 是否必填:否 -(过滤条件)按照命令类型过滤,取值为 SHELL 或 POWERSHELL。
|
454
|
+
# <li> created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。
|
455
|
+
# <li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li>
|
456
|
+
# <li> tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li>
|
457
|
+
# <li> tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例4</li>
|
458
|
+
|
459
|
+
# 每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。
|
460
|
+
# @type Filters: Array
|
461
|
+
# @param Limit: 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
462
|
+
# @type Limit: Integer
|
463
|
+
# @param Offset: 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
464
|
+
# @type Offset: Integer
|
465
|
+
|
466
|
+
attr_accessor :CommandIds, :Filters, :Limit, :Offset
|
467
|
+
|
468
|
+
def initialize(commandids=nil, filters=nil, limit=nil, offset=nil)
|
469
|
+
@CommandIds = commandids
|
470
|
+
@Filters = filters
|
471
|
+
@Limit = limit
|
472
|
+
@Offset = offset
|
473
|
+
end
|
474
|
+
|
475
|
+
def deserialize(params)
|
476
|
+
@CommandIds = params['CommandIds']
|
477
|
+
unless params['Filters'].nil?
|
478
|
+
@Filters = []
|
479
|
+
params['Filters'].each do |i|
|
480
|
+
filter_tmp = Filter.new
|
481
|
+
filter_tmp.deserialize(i)
|
482
|
+
@Filters << filter_tmp
|
483
|
+
end
|
484
|
+
end
|
485
|
+
@Limit = params['Limit']
|
486
|
+
@Offset = params['Offset']
|
487
|
+
end
|
488
|
+
end
|
489
|
+
|
490
|
+
# DescribeCommands返回参数结构体
|
491
|
+
class DescribeCommandsResponse < TencentCloud::Common::AbstractModel
|
492
|
+
# @param TotalCount: 符合条件的命令总数。
|
493
|
+
# @type TotalCount: Integer
|
494
|
+
# @param CommandSet: 命令详情列表。
|
495
|
+
# @type CommandSet: Array
|
496
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
497
|
+
# @type RequestId: String
|
498
|
+
|
499
|
+
attr_accessor :TotalCount, :CommandSet, :RequestId
|
500
|
+
|
501
|
+
def initialize(totalcount=nil, commandset=nil, requestid=nil)
|
502
|
+
@TotalCount = totalcount
|
503
|
+
@CommandSet = commandset
|
504
|
+
@RequestId = requestid
|
505
|
+
end
|
506
|
+
|
507
|
+
def deserialize(params)
|
508
|
+
@TotalCount = params['TotalCount']
|
509
|
+
unless params['CommandSet'].nil?
|
510
|
+
@CommandSet = []
|
511
|
+
params['CommandSet'].each do |i|
|
512
|
+
command_tmp = Command.new
|
513
|
+
command_tmp.deserialize(i)
|
514
|
+
@CommandSet << command_tmp
|
515
|
+
end
|
516
|
+
end
|
517
|
+
@RequestId = params['RequestId']
|
518
|
+
end
|
519
|
+
end
|
520
|
+
|
521
|
+
# DescribeInvocationTasks请求参数结构体
|
522
|
+
class DescribeInvocationTasksRequest < TencentCloud::Common::AbstractModel
|
523
|
+
# @param InvocationTaskIds: 执行任务ID列表,每次请求的上限为100。参数不支持同时指定 `InvocationTaskIds` 和 `Filters`。
|
524
|
+
# @type InvocationTaskIds: Array
|
525
|
+
# @param Filters: 过滤条件。<br> <li> invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。<br> <li> invocation-task-id - String - 是否必填:否 -(过滤条件)按照执行任务ID过滤。<br> <li> instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationTaskIds` 和 `Filters` 。
|
526
|
+
# @type Filters: Array
|
527
|
+
# @param Limit: 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
528
|
+
# @type Limit: Integer
|
529
|
+
# @param Offset: 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
530
|
+
# @type Offset: Integer
|
531
|
+
# @param HideOutput: 是否隐藏输出,取值范围:<br><li>True:隐藏输出 <br><li>False:不隐藏 <br>默认为 True。
|
532
|
+
# @type HideOutput: Boolean
|
533
|
+
|
534
|
+
attr_accessor :InvocationTaskIds, :Filters, :Limit, :Offset, :HideOutput
|
535
|
+
|
536
|
+
def initialize(invocationtaskids=nil, filters=nil, limit=nil, offset=nil, hideoutput=nil)
|
537
|
+
@InvocationTaskIds = invocationtaskids
|
538
|
+
@Filters = filters
|
539
|
+
@Limit = limit
|
540
|
+
@Offset = offset
|
541
|
+
@HideOutput = hideoutput
|
542
|
+
end
|
543
|
+
|
544
|
+
def deserialize(params)
|
545
|
+
@InvocationTaskIds = params['InvocationTaskIds']
|
546
|
+
unless params['Filters'].nil?
|
547
|
+
@Filters = []
|
548
|
+
params['Filters'].each do |i|
|
549
|
+
filter_tmp = Filter.new
|
550
|
+
filter_tmp.deserialize(i)
|
551
|
+
@Filters << filter_tmp
|
552
|
+
end
|
553
|
+
end
|
554
|
+
@Limit = params['Limit']
|
555
|
+
@Offset = params['Offset']
|
556
|
+
@HideOutput = params['HideOutput']
|
557
|
+
end
|
558
|
+
end
|
559
|
+
|
560
|
+
# DescribeInvocationTasks返回参数结构体
|
561
|
+
class DescribeInvocationTasksResponse < TencentCloud::Common::AbstractModel
|
562
|
+
# @param TotalCount: 符合条件的执行任务总数。
|
563
|
+
# @type TotalCount: Integer
|
564
|
+
# @param InvocationTaskSet: 执行任务列表。
|
565
|
+
# @type InvocationTaskSet: Array
|
566
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
567
|
+
# @type RequestId: String
|
568
|
+
|
569
|
+
attr_accessor :TotalCount, :InvocationTaskSet, :RequestId
|
570
|
+
|
571
|
+
def initialize(totalcount=nil, invocationtaskset=nil, requestid=nil)
|
572
|
+
@TotalCount = totalcount
|
573
|
+
@InvocationTaskSet = invocationtaskset
|
574
|
+
@RequestId = requestid
|
575
|
+
end
|
576
|
+
|
577
|
+
def deserialize(params)
|
578
|
+
@TotalCount = params['TotalCount']
|
579
|
+
unless params['InvocationTaskSet'].nil?
|
580
|
+
@InvocationTaskSet = []
|
581
|
+
params['InvocationTaskSet'].each do |i|
|
582
|
+
invocationtask_tmp = InvocationTask.new
|
583
|
+
invocationtask_tmp.deserialize(i)
|
584
|
+
@InvocationTaskSet << invocationtask_tmp
|
585
|
+
end
|
586
|
+
end
|
587
|
+
@RequestId = params['RequestId']
|
588
|
+
end
|
589
|
+
end
|
590
|
+
|
591
|
+
# DescribeInvocations请求参数结构体
|
592
|
+
class DescribeInvocationsRequest < TencentCloud::Common::AbstractModel
|
593
|
+
# @param InvocationIds: 执行活动ID列表,每次请求的上限为100。参数不支持同时指定 `InvocationIds` 和 `Filters`。
|
594
|
+
# @type InvocationIds: Array
|
595
|
+
# @param Filters: 过滤条件。<br> <li> invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。<br>
|
596
|
+
# <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。
|
597
|
+
# <li> command-created-by - String - 是否必填:否 -(过滤条件)按照执行的命令类型过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。
|
598
|
+
# <li> instance-kind - String - 是否必填:否 -(过滤条件)按照运行实例类型过滤,取值为 CVM 或 LIGHTHOUSE,CVM 代表实例为云服务器, LIGHTHOUSE 代表实例为轻量应用服务器。
|
599
|
+
# <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationIds` 和 `Filters` 。
|
600
|
+
# @type Filters: Array
|
601
|
+
# @param Limit: 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
602
|
+
# @type Limit: Integer
|
603
|
+
# @param Offset: 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
|
604
|
+
# @type Offset: Integer
|
605
|
+
|
606
|
+
attr_accessor :InvocationIds, :Filters, :Limit, :Offset
|
607
|
+
|
608
|
+
def initialize(invocationids=nil, filters=nil, limit=nil, offset=nil)
|
609
|
+
@InvocationIds = invocationids
|
610
|
+
@Filters = filters
|
611
|
+
@Limit = limit
|
612
|
+
@Offset = offset
|
613
|
+
end
|
614
|
+
|
615
|
+
def deserialize(params)
|
616
|
+
@InvocationIds = params['InvocationIds']
|
617
|
+
unless params['Filters'].nil?
|
618
|
+
@Filters = []
|
619
|
+
params['Filters'].each do |i|
|
620
|
+
filter_tmp = Filter.new
|
621
|
+
filter_tmp.deserialize(i)
|
622
|
+
@Filters << filter_tmp
|
623
|
+
end
|
624
|
+
end
|
625
|
+
@Limit = params['Limit']
|
626
|
+
@Offset = params['Offset']
|
627
|
+
end
|
628
|
+
end
|
629
|
+
|
630
|
+
# DescribeInvocations返回参数结构体
|
631
|
+
class DescribeInvocationsResponse < TencentCloud::Common::AbstractModel
|
632
|
+
# @param TotalCount: 符合条件的执行活动总数。
|
633
|
+
# @type TotalCount: Integer
|
634
|
+
# @param InvocationSet: 执行活动列表。
|
635
|
+
# @type InvocationSet: Array
|
636
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
637
|
+
# @type RequestId: String
|
638
|
+
|
639
|
+
attr_accessor :TotalCount, :InvocationSet, :RequestId
|
640
|
+
|
641
|
+
def initialize(totalcount=nil, invocationset=nil, requestid=nil)
|
642
|
+
@TotalCount = totalcount
|
643
|
+
@InvocationSet = invocationset
|
644
|
+
@RequestId = requestid
|
645
|
+
end
|
646
|
+
|
647
|
+
def deserialize(params)
|
648
|
+
@TotalCount = params['TotalCount']
|
649
|
+
unless params['InvocationSet'].nil?
|
650
|
+
@InvocationSet = []
|
651
|
+
params['InvocationSet'].each do |i|
|
652
|
+
invocation_tmp = Invocation.new
|
653
|
+
invocation_tmp.deserialize(i)
|
654
|
+
@InvocationSet << invocation_tmp
|
655
|
+
end
|
656
|
+
end
|
657
|
+
@RequestId = params['RequestId']
|
658
|
+
end
|
659
|
+
end
|
660
|
+
|
661
|
+
# DescribeInvokerRecords请求参数结构体
|
662
|
+
class DescribeInvokerRecordsRequest < TencentCloud::Common::AbstractModel
|
663
|
+
# @param InvokerIds: 执行器ID列表。列表上限 100。
|
664
|
+
# @type InvokerIds: Array
|
665
|
+
# @param Limit: 返回数量,默认为20,最大值为100。
|
666
|
+
# @type Limit: Integer
|
667
|
+
# @param Offset: 偏移量,默认为0。
|
668
|
+
# @type Offset: Integer
|
669
|
+
|
670
|
+
attr_accessor :InvokerIds, :Limit, :Offset
|
671
|
+
|
672
|
+
def initialize(invokerids=nil, limit=nil, offset=nil)
|
673
|
+
@InvokerIds = invokerids
|
674
|
+
@Limit = limit
|
675
|
+
@Offset = offset
|
676
|
+
end
|
677
|
+
|
678
|
+
def deserialize(params)
|
679
|
+
@InvokerIds = params['InvokerIds']
|
680
|
+
@Limit = params['Limit']
|
681
|
+
@Offset = params['Offset']
|
682
|
+
end
|
683
|
+
end
|
684
|
+
|
685
|
+
# DescribeInvokerRecords返回参数结构体
|
686
|
+
class DescribeInvokerRecordsResponse < TencentCloud::Common::AbstractModel
|
687
|
+
# @param TotalCount: 符合条件的历史记录数量。
|
688
|
+
# @type TotalCount: Integer
|
689
|
+
# @param InvokerRecordSet: 执行器执行历史记录。
|
690
|
+
# @type InvokerRecordSet: Array
|
691
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
692
|
+
# @type RequestId: String
|
693
|
+
|
694
|
+
attr_accessor :TotalCount, :InvokerRecordSet, :RequestId
|
695
|
+
|
696
|
+
def initialize(totalcount=nil, invokerrecordset=nil, requestid=nil)
|
697
|
+
@TotalCount = totalcount
|
698
|
+
@InvokerRecordSet = invokerrecordset
|
699
|
+
@RequestId = requestid
|
700
|
+
end
|
701
|
+
|
702
|
+
def deserialize(params)
|
703
|
+
@TotalCount = params['TotalCount']
|
704
|
+
unless params['InvokerRecordSet'].nil?
|
705
|
+
@InvokerRecordSet = []
|
706
|
+
params['InvokerRecordSet'].each do |i|
|
707
|
+
invokerrecord_tmp = InvokerRecord.new
|
708
|
+
invokerrecord_tmp.deserialize(i)
|
709
|
+
@InvokerRecordSet << invokerrecord_tmp
|
710
|
+
end
|
711
|
+
end
|
712
|
+
@RequestId = params['RequestId']
|
713
|
+
end
|
714
|
+
end
|
715
|
+
|
716
|
+
# DescribeInvokers请求参数结构体
|
717
|
+
class DescribeInvokersRequest < TencentCloud::Common::AbstractModel
|
718
|
+
# @param InvokerIds: 执行器ID列表。
|
719
|
+
# @type InvokerIds: Array
|
720
|
+
# @param Filters: 过滤条件:
|
721
|
+
|
722
|
+
# <li> invoker-id - String - 是否必填:否 - (过滤条件)按执行器ID过滤。
|
723
|
+
# <li> command-id - String - 是否必填:否 - (过滤条件)按命令ID过滤。
|
724
|
+
# <li> type - String - 是否必填:否 - (过滤条件)按执行器类型过滤。
|
725
|
+
# @type Filters: Array
|
726
|
+
# @param Limit: 返回数量,默认为20,最大值为100。
|
727
|
+
# @type Limit: Integer
|
728
|
+
# @param Offset: 偏移量,默认为0。
|
729
|
+
# @type Offset: Integer
|
730
|
+
|
731
|
+
attr_accessor :InvokerIds, :Filters, :Limit, :Offset
|
732
|
+
|
733
|
+
def initialize(invokerids=nil, filters=nil, limit=nil, offset=nil)
|
734
|
+
@InvokerIds = invokerids
|
735
|
+
@Filters = filters
|
736
|
+
@Limit = limit
|
737
|
+
@Offset = offset
|
738
|
+
end
|
739
|
+
|
740
|
+
def deserialize(params)
|
741
|
+
@InvokerIds = params['InvokerIds']
|
742
|
+
unless params['Filters'].nil?
|
743
|
+
@Filters = []
|
744
|
+
params['Filters'].each do |i|
|
745
|
+
filter_tmp = Filter.new
|
746
|
+
filter_tmp.deserialize(i)
|
747
|
+
@Filters << filter_tmp
|
748
|
+
end
|
749
|
+
end
|
750
|
+
@Limit = params['Limit']
|
751
|
+
@Offset = params['Offset']
|
752
|
+
end
|
753
|
+
end
|
754
|
+
|
755
|
+
# DescribeInvokers返回参数结构体
|
756
|
+
class DescribeInvokersResponse < TencentCloud::Common::AbstractModel
|
757
|
+
# @param TotalCount: 满足条件的执行器数量。
|
758
|
+
# @type TotalCount: Integer
|
759
|
+
# @param InvokerSet: 执行器信息。
|
760
|
+
# @type InvokerSet: Array
|
761
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
762
|
+
# @type RequestId: String
|
763
|
+
|
764
|
+
attr_accessor :TotalCount, :InvokerSet, :RequestId
|
765
|
+
|
766
|
+
def initialize(totalcount=nil, invokerset=nil, requestid=nil)
|
767
|
+
@TotalCount = totalcount
|
768
|
+
@InvokerSet = invokerset
|
769
|
+
@RequestId = requestid
|
770
|
+
end
|
771
|
+
|
772
|
+
def deserialize(params)
|
773
|
+
@TotalCount = params['TotalCount']
|
774
|
+
unless params['InvokerSet'].nil?
|
775
|
+
@InvokerSet = []
|
776
|
+
params['InvokerSet'].each do |i|
|
777
|
+
invoker_tmp = Invoker.new
|
778
|
+
invoker_tmp.deserialize(i)
|
779
|
+
@InvokerSet << invoker_tmp
|
780
|
+
end
|
781
|
+
end
|
782
|
+
@RequestId = params['RequestId']
|
783
|
+
end
|
784
|
+
end
|
785
|
+
|
786
|
+
# DescribeRegions请求参数结构体
|
787
|
+
class DescribeRegionsRequest < TencentCloud::Common::AbstractModel
|
788
|
+
|
789
|
+
|
790
|
+
def initialize()
|
791
|
+
end
|
792
|
+
|
793
|
+
def deserialize(params)
|
794
|
+
end
|
795
|
+
end
|
796
|
+
|
797
|
+
# DescribeRegions返回参数结构体
|
798
|
+
class DescribeRegionsResponse < TencentCloud::Common::AbstractModel
|
799
|
+
# @param TotalCount: 地域数量
|
800
|
+
# @type TotalCount: Integer
|
801
|
+
# @param RegionSet: 地域信息列表
|
802
|
+
# @type RegionSet: Array
|
803
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
804
|
+
# @type RequestId: String
|
805
|
+
|
806
|
+
attr_accessor :TotalCount, :RegionSet, :RequestId
|
807
|
+
|
808
|
+
def initialize(totalcount=nil, regionset=nil, requestid=nil)
|
809
|
+
@TotalCount = totalcount
|
810
|
+
@RegionSet = regionset
|
811
|
+
@RequestId = requestid
|
812
|
+
end
|
813
|
+
|
814
|
+
def deserialize(params)
|
815
|
+
@TotalCount = params['TotalCount']
|
816
|
+
unless params['RegionSet'].nil?
|
817
|
+
@RegionSet = []
|
818
|
+
params['RegionSet'].each do |i|
|
819
|
+
regioninfo_tmp = RegionInfo.new
|
820
|
+
regioninfo_tmp.deserialize(i)
|
821
|
+
@RegionSet << regioninfo_tmp
|
822
|
+
end
|
823
|
+
end
|
824
|
+
@RequestId = params['RequestId']
|
825
|
+
end
|
826
|
+
end
|
827
|
+
|
828
|
+
# DisableInvoker请求参数结构体
|
829
|
+
class DisableInvokerRequest < TencentCloud::Common::AbstractModel
|
830
|
+
# @param InvokerId: 待停止的执行器ID。
|
831
|
+
# @type InvokerId: String
|
832
|
+
|
833
|
+
attr_accessor :InvokerId
|
834
|
+
|
835
|
+
def initialize(invokerid=nil)
|
836
|
+
@InvokerId = invokerid
|
837
|
+
end
|
838
|
+
|
839
|
+
def deserialize(params)
|
840
|
+
@InvokerId = params['InvokerId']
|
841
|
+
end
|
842
|
+
end
|
843
|
+
|
844
|
+
# DisableInvoker返回参数结构体
|
845
|
+
class DisableInvokerResponse < TencentCloud::Common::AbstractModel
|
846
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
847
|
+
# @type RequestId: String
|
848
|
+
|
849
|
+
attr_accessor :RequestId
|
850
|
+
|
851
|
+
def initialize(requestid=nil)
|
852
|
+
@RequestId = requestid
|
853
|
+
end
|
854
|
+
|
855
|
+
def deserialize(params)
|
856
|
+
@RequestId = params['RequestId']
|
857
|
+
end
|
858
|
+
end
|
859
|
+
|
860
|
+
# EnableInvoker请求参数结构体
|
861
|
+
class EnableInvokerRequest < TencentCloud::Common::AbstractModel
|
862
|
+
# @param InvokerId: 待启用的执行器ID。
|
863
|
+
# @type InvokerId: String
|
864
|
+
|
865
|
+
attr_accessor :InvokerId
|
866
|
+
|
867
|
+
def initialize(invokerid=nil)
|
868
|
+
@InvokerId = invokerid
|
869
|
+
end
|
870
|
+
|
871
|
+
def deserialize(params)
|
872
|
+
@InvokerId = params['InvokerId']
|
873
|
+
end
|
874
|
+
end
|
875
|
+
|
876
|
+
# EnableInvoker返回参数结构体
|
877
|
+
class EnableInvokerResponse < TencentCloud::Common::AbstractModel
|
878
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
879
|
+
# @type RequestId: String
|
880
|
+
|
881
|
+
attr_accessor :RequestId
|
882
|
+
|
883
|
+
def initialize(requestid=nil)
|
884
|
+
@RequestId = requestid
|
885
|
+
end
|
886
|
+
|
887
|
+
def deserialize(params)
|
888
|
+
@RequestId = params['RequestId']
|
889
|
+
end
|
890
|
+
end
|
891
|
+
|
892
|
+
# >描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
|
893
|
+
# > * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。
|
894
|
+
# > * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。
|
895
|
+
# >
|
896
|
+
# > 以[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口的`Filter`为例。若我们需要查询可用区(`zone`)为广州一区 ***并且*** 实例计费模式(`instance-charge-type`)为包年包月 ***或者*** 按量计费的实例时,可如下实现:
|
897
|
+
# ```
|
898
|
+
# Filters.0.Name=zone
|
899
|
+
# &Filters.0.Values.0=ap-guangzhou-1
|
900
|
+
# &Filters.1.Name=instance-charge-type
|
901
|
+
# &Filters.1.Values.0=PREPAID
|
902
|
+
# &Filters.1.Values.1=POSTPAID_BY_HOUR
|
903
|
+
# ```
|
904
|
+
class Filter < TencentCloud::Common::AbstractModel
|
905
|
+
# @param Name: 需要过滤的字段。
|
906
|
+
# @type Name: String
|
907
|
+
# @param Values: 字段的过滤值。
|
908
|
+
# @type Values: Array
|
909
|
+
|
910
|
+
attr_accessor :Name, :Values
|
911
|
+
|
912
|
+
def initialize(name=nil, values=nil)
|
913
|
+
@Name = name
|
914
|
+
@Values = values
|
915
|
+
end
|
916
|
+
|
917
|
+
def deserialize(params)
|
918
|
+
@Name = params['Name']
|
919
|
+
@Values = params['Values']
|
920
|
+
end
|
921
|
+
end
|
922
|
+
|
923
|
+
# 执行活动详情。
|
924
|
+
class Invocation < TencentCloud::Common::AbstractModel
|
925
|
+
# @param InvocationId: 执行活动ID。
|
926
|
+
# @type InvocationId: String
|
927
|
+
# @param CommandId: 命令ID。
|
928
|
+
# @type CommandId: String
|
929
|
+
# @param InvocationStatus: 执行任务状态。取值范围:
|
930
|
+
# <li> PENDING:等待下发
|
931
|
+
# <li> RUNNING:命令运行中
|
932
|
+
# <li> SUCCESS:命令成功
|
933
|
+
# <li> FAILED:命令失败
|
934
|
+
# <li> TIMEOUT:命令超时
|
935
|
+
# <li> PARTIAL_FAILED:命令部分失败
|
936
|
+
# @type InvocationStatus: String
|
937
|
+
# @param InvocationTaskBasicInfoSet: 执行任务信息列表。
|
938
|
+
# @type InvocationTaskBasicInfoSet: Array
|
939
|
+
# @param Description: 执行活动描述。
|
940
|
+
# @type Description: String
|
941
|
+
# @param StartTime: 执行活动开始时间。
|
942
|
+
# @type StartTime: String
|
943
|
+
# @param EndTime: 执行活动结束时间。
|
944
|
+
# @type EndTime: String
|
945
|
+
# @param CreatedTime: 执行活动创建时间。
|
946
|
+
# @type CreatedTime: String
|
947
|
+
# @param UpdatedTime: 执行活动更新时间。
|
948
|
+
# @type UpdatedTime: String
|
949
|
+
# @param Parameters: 自定义参数取值。
|
950
|
+
# @type Parameters: String
|
951
|
+
# @param DefaultParameters: 自定义参数的默认取值。
|
952
|
+
# @type DefaultParameters: String
|
953
|
+
# @param InstanceKind: 执行命令的实例类型,取值范围:CVM、LIGHTHOUSE。
|
954
|
+
# @type InstanceKind: String
|
955
|
+
# @param Username: 在实例上执行命令时使用的用户名。
|
956
|
+
# @type Username: String
|
957
|
+
# @param InvocationSource: 调用来源。
|
958
|
+
# @type InvocationSource: String
|
959
|
+
# @param CommandContent: base64编码的命令内容
|
960
|
+
# @type CommandContent: String
|
961
|
+
# @param CommandType: 命令类型
|
962
|
+
# @type CommandType: String
|
963
|
+
# @param Timeout: 执行命令过期时间, 单位秒
|
964
|
+
# @type Timeout: Integer
|
965
|
+
# @param WorkingDirectory: 执行命令的工作路径
|
966
|
+
# @type WorkingDirectory: String
|
967
|
+
|
968
|
+
attr_accessor :InvocationId, :CommandId, :InvocationStatus, :InvocationTaskBasicInfoSet, :Description, :StartTime, :EndTime, :CreatedTime, :UpdatedTime, :Parameters, :DefaultParameters, :InstanceKind, :Username, :InvocationSource, :CommandContent, :CommandType, :Timeout, :WorkingDirectory
|
969
|
+
|
970
|
+
def initialize(invocationid=nil, commandid=nil, invocationstatus=nil, invocationtaskbasicinfoset=nil, description=nil, starttime=nil, endtime=nil, createdtime=nil, updatedtime=nil, parameters=nil, defaultparameters=nil, instancekind=nil, username=nil, invocationsource=nil, commandcontent=nil, commandtype=nil, timeout=nil, workingdirectory=nil)
|
971
|
+
@InvocationId = invocationid
|
972
|
+
@CommandId = commandid
|
973
|
+
@InvocationStatus = invocationstatus
|
974
|
+
@InvocationTaskBasicInfoSet = invocationtaskbasicinfoset
|
975
|
+
@Description = description
|
976
|
+
@StartTime = starttime
|
977
|
+
@EndTime = endtime
|
978
|
+
@CreatedTime = createdtime
|
979
|
+
@UpdatedTime = updatedtime
|
980
|
+
@Parameters = parameters
|
981
|
+
@DefaultParameters = defaultparameters
|
982
|
+
@InstanceKind = instancekind
|
983
|
+
@Username = username
|
984
|
+
@InvocationSource = invocationsource
|
985
|
+
@CommandContent = commandcontent
|
986
|
+
@CommandType = commandtype
|
987
|
+
@Timeout = timeout
|
988
|
+
@WorkingDirectory = workingdirectory
|
989
|
+
end
|
990
|
+
|
991
|
+
def deserialize(params)
|
992
|
+
@InvocationId = params['InvocationId']
|
993
|
+
@CommandId = params['CommandId']
|
994
|
+
@InvocationStatus = params['InvocationStatus']
|
995
|
+
unless params['InvocationTaskBasicInfoSet'].nil?
|
996
|
+
@InvocationTaskBasicInfoSet = []
|
997
|
+
params['InvocationTaskBasicInfoSet'].each do |i|
|
998
|
+
invocationtaskbasicinfo_tmp = InvocationTaskBasicInfo.new
|
999
|
+
invocationtaskbasicinfo_tmp.deserialize(i)
|
1000
|
+
@InvocationTaskBasicInfoSet << invocationtaskbasicinfo_tmp
|
1001
|
+
end
|
1002
|
+
end
|
1003
|
+
@Description = params['Description']
|
1004
|
+
@StartTime = params['StartTime']
|
1005
|
+
@EndTime = params['EndTime']
|
1006
|
+
@CreatedTime = params['CreatedTime']
|
1007
|
+
@UpdatedTime = params['UpdatedTime']
|
1008
|
+
@Parameters = params['Parameters']
|
1009
|
+
@DefaultParameters = params['DefaultParameters']
|
1010
|
+
@InstanceKind = params['InstanceKind']
|
1011
|
+
@Username = params['Username']
|
1012
|
+
@InvocationSource = params['InvocationSource']
|
1013
|
+
@CommandContent = params['CommandContent']
|
1014
|
+
@CommandType = params['CommandType']
|
1015
|
+
@Timeout = params['Timeout']
|
1016
|
+
@WorkingDirectory = params['WorkingDirectory']
|
1017
|
+
end
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
# 执行任务。
|
1021
|
+
class InvocationTask < TencentCloud::Common::AbstractModel
|
1022
|
+
# @param InvocationId: 执行活动ID。
|
1023
|
+
# @type InvocationId: String
|
1024
|
+
# @param InvocationTaskId: 执行任务ID。
|
1025
|
+
# @type InvocationTaskId: String
|
1026
|
+
# @param CommandId: 命令ID。
|
1027
|
+
# @type CommandId: String
|
1028
|
+
# @param TaskStatus: 执行任务状态。取值范围:
|
1029
|
+
# <li> PENDING:等待下发
|
1030
|
+
# <li> DELIVERING:下发中
|
1031
|
+
# <li> DELIVER_DELAYED:延时下发
|
1032
|
+
# <li> DELIVER_FAILED:下发失败
|
1033
|
+
# <li> START_FAILED:命令启动失败
|
1034
|
+
# <li> RUNNING:命令运行中
|
1035
|
+
# <li> SUCCESS:命令成功
|
1036
|
+
# <li> FAILED:命令执行失败,执行完退出码不为 0
|
1037
|
+
# <li> TIMEOUT:命令超时
|
1038
|
+
# <li> TASK_TIMEOUT:执行任务超时
|
1039
|
+
# @type TaskStatus: String
|
1040
|
+
# @param InstanceId: 实例ID。
|
1041
|
+
# @type InstanceId: String
|
1042
|
+
# @param TaskResult: 执行结果。
|
1043
|
+
# @type TaskResult: :class:`Tencentcloud::Tat.v20201028.models.TaskResult`
|
1044
|
+
# @param StartTime: 执行任务开始时间。
|
1045
|
+
# @type StartTime: String
|
1046
|
+
# @param EndTime: 执行任务结束时间。
|
1047
|
+
# @type EndTime: String
|
1048
|
+
# @param CreatedTime: 创建时间。
|
1049
|
+
# @type CreatedTime: String
|
1050
|
+
# @param UpdatedTime: 更新时间。
|
1051
|
+
# @type UpdatedTime: String
|
1052
|
+
# @param CommandDocument: 执行任务所执行的命令详情。
|
1053
|
+
# @type CommandDocument: :class:`Tencentcloud::Tat.v20201028.models.CommandDocument`
|
1054
|
+
# @param ErrorInfo: 执行任务失败时的错误信息。
|
1055
|
+
# @type ErrorInfo: String
|
1056
|
+
# @param InvocationSource: 调用来源。
|
1057
|
+
# @type InvocationSource: String
|
1058
|
+
|
1059
|
+
attr_accessor :InvocationId, :InvocationTaskId, :CommandId, :TaskStatus, :InstanceId, :TaskResult, :StartTime, :EndTime, :CreatedTime, :UpdatedTime, :CommandDocument, :ErrorInfo, :InvocationSource
|
1060
|
+
|
1061
|
+
def initialize(invocationid=nil, invocationtaskid=nil, commandid=nil, taskstatus=nil, instanceid=nil, taskresult=nil, starttime=nil, endtime=nil, createdtime=nil, updatedtime=nil, commanddocument=nil, errorinfo=nil, invocationsource=nil)
|
1062
|
+
@InvocationId = invocationid
|
1063
|
+
@InvocationTaskId = invocationtaskid
|
1064
|
+
@CommandId = commandid
|
1065
|
+
@TaskStatus = taskstatus
|
1066
|
+
@InstanceId = instanceid
|
1067
|
+
@TaskResult = taskresult
|
1068
|
+
@StartTime = starttime
|
1069
|
+
@EndTime = endtime
|
1070
|
+
@CreatedTime = createdtime
|
1071
|
+
@UpdatedTime = updatedtime
|
1072
|
+
@CommandDocument = commanddocument
|
1073
|
+
@ErrorInfo = errorinfo
|
1074
|
+
@InvocationSource = invocationsource
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
def deserialize(params)
|
1078
|
+
@InvocationId = params['InvocationId']
|
1079
|
+
@InvocationTaskId = params['InvocationTaskId']
|
1080
|
+
@CommandId = params['CommandId']
|
1081
|
+
@TaskStatus = params['TaskStatus']
|
1082
|
+
@InstanceId = params['InstanceId']
|
1083
|
+
unless params['TaskResult'].nil?
|
1084
|
+
@TaskResult = TaskResult.new
|
1085
|
+
@TaskResult.deserialize(params['TaskResult'])
|
1086
|
+
end
|
1087
|
+
@StartTime = params['StartTime']
|
1088
|
+
@EndTime = params['EndTime']
|
1089
|
+
@CreatedTime = params['CreatedTime']
|
1090
|
+
@UpdatedTime = params['UpdatedTime']
|
1091
|
+
unless params['CommandDocument'].nil?
|
1092
|
+
@CommandDocument = CommandDocument.new
|
1093
|
+
@CommandDocument.deserialize(params['CommandDocument'])
|
1094
|
+
end
|
1095
|
+
@ErrorInfo = params['ErrorInfo']
|
1096
|
+
@InvocationSource = params['InvocationSource']
|
1097
|
+
end
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# 执行活动任务简介。
|
1101
|
+
class InvocationTaskBasicInfo < TencentCloud::Common::AbstractModel
|
1102
|
+
# @param InvocationTaskId: 执行任务ID。
|
1103
|
+
# @type InvocationTaskId: String
|
1104
|
+
# @param TaskStatus: 执行任务状态。取值范围:
|
1105
|
+
# <li> PENDING:等待下发
|
1106
|
+
# <li> DELIVERING:下发中
|
1107
|
+
# <li> DELIVER_DELAYED:延时下发
|
1108
|
+
# <li> DELIVER_FAILED:下发失败
|
1109
|
+
# <li> RUNNING:命令运行中
|
1110
|
+
# <li> SUCCESS:命令成功
|
1111
|
+
# <li> FAILED:命令失败
|
1112
|
+
# <li> TIMEOUT:命令超时
|
1113
|
+
# <li> TASK_TIMEOUT:执行任务超时
|
1114
|
+
# @type TaskStatus: String
|
1115
|
+
# @param InstanceId: 实例ID。
|
1116
|
+
# @type InstanceId: String
|
1117
|
+
|
1118
|
+
attr_accessor :InvocationTaskId, :TaskStatus, :InstanceId
|
1119
|
+
|
1120
|
+
def initialize(invocationtaskid=nil, taskstatus=nil, instanceid=nil)
|
1121
|
+
@InvocationTaskId = invocationtaskid
|
1122
|
+
@TaskStatus = taskstatus
|
1123
|
+
@InstanceId = instanceid
|
1124
|
+
end
|
1125
|
+
|
1126
|
+
def deserialize(params)
|
1127
|
+
@InvocationTaskId = params['InvocationTaskId']
|
1128
|
+
@TaskStatus = params['TaskStatus']
|
1129
|
+
@InstanceId = params['InstanceId']
|
1130
|
+
end
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# InvokeCommand请求参数结构体
|
1134
|
+
class InvokeCommandRequest < TencentCloud::Common::AbstractModel
|
1135
|
+
# @param CommandId: 待触发的命令ID。
|
1136
|
+
# @type CommandId: String
|
1137
|
+
# @param InstanceIds: 待执行命令的实例ID列表,上限100。
|
1138
|
+
# @type InstanceIds: Array
|
1139
|
+
# @param Parameters: Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
|
1140
|
+
# key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
1141
|
+
# 如果未提供该参数取值,将使用 Command 的 DefaultParameters 进行替换。
|
1142
|
+
# 自定义参数最多20个。
|
1143
|
+
# 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
1144
|
+
# @type Parameters: String
|
1145
|
+
# @param Username: 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
|
1146
|
+
# 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。
|
1147
|
+
# @type Username: String
|
1148
|
+
# @param WorkingDirectory: 命令执行路径, 默认以Command配置的WorkingDirectory执行。
|
1149
|
+
# @type WorkingDirectory: String
|
1150
|
+
# @param Timeout: 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。
|
1151
|
+
# @type Timeout: Integer
|
1152
|
+
|
1153
|
+
attr_accessor :CommandId, :InstanceIds, :Parameters, :Username, :WorkingDirectory, :Timeout
|
1154
|
+
|
1155
|
+
def initialize(commandid=nil, instanceids=nil, parameters=nil, username=nil, workingdirectory=nil, timeout=nil)
|
1156
|
+
@CommandId = commandid
|
1157
|
+
@InstanceIds = instanceids
|
1158
|
+
@Parameters = parameters
|
1159
|
+
@Username = username
|
1160
|
+
@WorkingDirectory = workingdirectory
|
1161
|
+
@Timeout = timeout
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
def deserialize(params)
|
1165
|
+
@CommandId = params['CommandId']
|
1166
|
+
@InstanceIds = params['InstanceIds']
|
1167
|
+
@Parameters = params['Parameters']
|
1168
|
+
@Username = params['Username']
|
1169
|
+
@WorkingDirectory = params['WorkingDirectory']
|
1170
|
+
@Timeout = params['Timeout']
|
1171
|
+
end
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
# InvokeCommand返回参数结构体
|
1175
|
+
class InvokeCommandResponse < TencentCloud::Common::AbstractModel
|
1176
|
+
# @param InvocationId: 执行活动ID。
|
1177
|
+
# @type InvocationId: String
|
1178
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1179
|
+
# @type RequestId: String
|
1180
|
+
|
1181
|
+
attr_accessor :InvocationId, :RequestId
|
1182
|
+
|
1183
|
+
def initialize(invocationid=nil, requestid=nil)
|
1184
|
+
@InvocationId = invocationid
|
1185
|
+
@RequestId = requestid
|
1186
|
+
end
|
1187
|
+
|
1188
|
+
def deserialize(params)
|
1189
|
+
@InvocationId = params['InvocationId']
|
1190
|
+
@RequestId = params['RequestId']
|
1191
|
+
end
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# 执行器信息。
|
1195
|
+
class Invoker < TencentCloud::Common::AbstractModel
|
1196
|
+
# @param InvokerId: 执行器ID。
|
1197
|
+
# @type InvokerId: String
|
1198
|
+
# @param Name: 执行器名称。
|
1199
|
+
# @type Name: String
|
1200
|
+
# @param Type: 执行器类型。
|
1201
|
+
# @type Type: String
|
1202
|
+
# @param CommandId: 命令ID。
|
1203
|
+
# @type CommandId: String
|
1204
|
+
# @param Username: 用户名。
|
1205
|
+
# @type Username: String
|
1206
|
+
# @param Parameters: 自定义参数。
|
1207
|
+
# @type Parameters: String
|
1208
|
+
# @param InstanceIds: 实例ID列表。
|
1209
|
+
# @type InstanceIds: Array
|
1210
|
+
# @param Enable: 执行器是否启用。
|
1211
|
+
# @type Enable: Boolean
|
1212
|
+
# @param ScheduleSettings: 执行器周期计划。周期执行器会返回此字段。
|
1213
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
1214
|
+
# @type ScheduleSettings: :class:`Tencentcloud::Tat.v20201028.models.ScheduleSettings`
|
1215
|
+
# @param CreatedTime: 创建时间。
|
1216
|
+
# @type CreatedTime: String
|
1217
|
+
# @param UpdatedTime: 修改时间。
|
1218
|
+
# @type UpdatedTime: String
|
1219
|
+
|
1220
|
+
attr_accessor :InvokerId, :Name, :Type, :CommandId, :Username, :Parameters, :InstanceIds, :Enable, :ScheduleSettings, :CreatedTime, :UpdatedTime
|
1221
|
+
|
1222
|
+
def initialize(invokerid=nil, name=nil, type=nil, commandid=nil, username=nil, parameters=nil, instanceids=nil, enable=nil, schedulesettings=nil, createdtime=nil, updatedtime=nil)
|
1223
|
+
@InvokerId = invokerid
|
1224
|
+
@Name = name
|
1225
|
+
@Type = type
|
1226
|
+
@CommandId = commandid
|
1227
|
+
@Username = username
|
1228
|
+
@Parameters = parameters
|
1229
|
+
@InstanceIds = instanceids
|
1230
|
+
@Enable = enable
|
1231
|
+
@ScheduleSettings = schedulesettings
|
1232
|
+
@CreatedTime = createdtime
|
1233
|
+
@UpdatedTime = updatedtime
|
1234
|
+
end
|
1235
|
+
|
1236
|
+
def deserialize(params)
|
1237
|
+
@InvokerId = params['InvokerId']
|
1238
|
+
@Name = params['Name']
|
1239
|
+
@Type = params['Type']
|
1240
|
+
@CommandId = params['CommandId']
|
1241
|
+
@Username = params['Username']
|
1242
|
+
@Parameters = params['Parameters']
|
1243
|
+
@InstanceIds = params['InstanceIds']
|
1244
|
+
@Enable = params['Enable']
|
1245
|
+
unless params['ScheduleSettings'].nil?
|
1246
|
+
@ScheduleSettings = ScheduleSettings.new
|
1247
|
+
@ScheduleSettings.deserialize(params['ScheduleSettings'])
|
1248
|
+
end
|
1249
|
+
@CreatedTime = params['CreatedTime']
|
1250
|
+
@UpdatedTime = params['UpdatedTime']
|
1251
|
+
end
|
1252
|
+
end
|
1253
|
+
|
1254
|
+
# 执行器执行记录。
|
1255
|
+
class InvokerRecord < TencentCloud::Common::AbstractModel
|
1256
|
+
# @param InvokerId: 执行器ID。
|
1257
|
+
# @type InvokerId: String
|
1258
|
+
# @param InvokeTime: 执行时间。
|
1259
|
+
# @type InvokeTime: String
|
1260
|
+
# @param Reason: 执行原因。
|
1261
|
+
# @type Reason: String
|
1262
|
+
# @param InvocationId: 命令执行ID。
|
1263
|
+
# @type InvocationId: String
|
1264
|
+
# @param Result: 触发结果。
|
1265
|
+
# @type Result: String
|
1266
|
+
|
1267
|
+
attr_accessor :InvokerId, :InvokeTime, :Reason, :InvocationId, :Result
|
1268
|
+
|
1269
|
+
def initialize(invokerid=nil, invoketime=nil, reason=nil, invocationid=nil, result=nil)
|
1270
|
+
@InvokerId = invokerid
|
1271
|
+
@InvokeTime = invoketime
|
1272
|
+
@Reason = reason
|
1273
|
+
@InvocationId = invocationid
|
1274
|
+
@Result = result
|
1275
|
+
end
|
1276
|
+
|
1277
|
+
def deserialize(params)
|
1278
|
+
@InvokerId = params['InvokerId']
|
1279
|
+
@InvokeTime = params['InvokeTime']
|
1280
|
+
@Reason = params['Reason']
|
1281
|
+
@InvocationId = params['InvocationId']
|
1282
|
+
@Result = params['Result']
|
1283
|
+
end
|
1284
|
+
end
|
1285
|
+
|
1286
|
+
# ModifyCommand请求参数结构体
|
1287
|
+
class ModifyCommandRequest < TencentCloud::Common::AbstractModel
|
1288
|
+
# @param CommandId: 命令ID。
|
1289
|
+
# @type CommandId: String
|
1290
|
+
# @param CommandName: 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
|
1291
|
+
# @type CommandName: String
|
1292
|
+
# @param Description: 命令描述。不超过120字符。
|
1293
|
+
# @type Description: String
|
1294
|
+
# @param Content: Base64编码后的命令内容,长度不可超过64KB。
|
1295
|
+
# @type Content: String
|
1296
|
+
# @param CommandType: 命令类型,目前仅支持取值:SHELL。
|
1297
|
+
# @type CommandType: String
|
1298
|
+
# @param WorkingDirectory: 命令执行路径,默认:`/root`。
|
1299
|
+
# @type WorkingDirectory: String
|
1300
|
+
# @param Timeout: 命令超时时间,默认60秒。取值范围[1, 86400]。
|
1301
|
+
# @type Timeout: Integer
|
1302
|
+
# @param DefaultParameters: 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。
|
1303
|
+
# 采取整体全覆盖式修改,即修改时必须提供所有新默认值。
|
1304
|
+
# 必须 Command 的 EnableParameter 为 true 时,才允许修改这个值。
|
1305
|
+
# key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
1306
|
+
# 自定义参数最多20个。
|
1307
|
+
# 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
1308
|
+
# @type DefaultParameters: String
|
1309
|
+
# @param Username: 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
|
1310
|
+
# 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在Linux实例中以root用户执行命令。
|
1311
|
+
# @type Username: String
|
1312
|
+
|
1313
|
+
attr_accessor :CommandId, :CommandName, :Description, :Content, :CommandType, :WorkingDirectory, :Timeout, :DefaultParameters, :Username
|
1314
|
+
|
1315
|
+
def initialize(commandid=nil, commandname=nil, description=nil, content=nil, commandtype=nil, workingdirectory=nil, timeout=nil, defaultparameters=nil, username=nil)
|
1316
|
+
@CommandId = commandid
|
1317
|
+
@CommandName = commandname
|
1318
|
+
@Description = description
|
1319
|
+
@Content = content
|
1320
|
+
@CommandType = commandtype
|
1321
|
+
@WorkingDirectory = workingdirectory
|
1322
|
+
@Timeout = timeout
|
1323
|
+
@DefaultParameters = defaultparameters
|
1324
|
+
@Username = username
|
1325
|
+
end
|
1326
|
+
|
1327
|
+
def deserialize(params)
|
1328
|
+
@CommandId = params['CommandId']
|
1329
|
+
@CommandName = params['CommandName']
|
1330
|
+
@Description = params['Description']
|
1331
|
+
@Content = params['Content']
|
1332
|
+
@CommandType = params['CommandType']
|
1333
|
+
@WorkingDirectory = params['WorkingDirectory']
|
1334
|
+
@Timeout = params['Timeout']
|
1335
|
+
@DefaultParameters = params['DefaultParameters']
|
1336
|
+
@Username = params['Username']
|
1337
|
+
end
|
1338
|
+
end
|
1339
|
+
|
1340
|
+
# ModifyCommand返回参数结构体
|
1341
|
+
class ModifyCommandResponse < TencentCloud::Common::AbstractModel
|
1342
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1343
|
+
# @type RequestId: String
|
1344
|
+
|
1345
|
+
attr_accessor :RequestId
|
1346
|
+
|
1347
|
+
def initialize(requestid=nil)
|
1348
|
+
@RequestId = requestid
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
def deserialize(params)
|
1352
|
+
@RequestId = params['RequestId']
|
1353
|
+
end
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
# ModifyInvoker请求参数结构体
|
1357
|
+
class ModifyInvokerRequest < TencentCloud::Common::AbstractModel
|
1358
|
+
# @param InvokerId: 待修改的执行器ID。
|
1359
|
+
# @type InvokerId: String
|
1360
|
+
# @param Name: 待修改的执行器名称。
|
1361
|
+
# @type Name: String
|
1362
|
+
# @param Type: 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
|
1363
|
+
# @type Type: String
|
1364
|
+
# @param CommandId: 待修改的命令ID。
|
1365
|
+
# @type CommandId: String
|
1366
|
+
# @param Username: 待修改的用户名。
|
1367
|
+
# @type Username: String
|
1368
|
+
# @param Parameters: 待修改的自定义参数。
|
1369
|
+
# @type Parameters: String
|
1370
|
+
# @param InstanceIds: 待修改的实例ID列表。列表长度上限100。
|
1371
|
+
# @type InstanceIds: Array
|
1372
|
+
# @param ScheduleSettings: 待修改的周期执行器设置。
|
1373
|
+
# @type ScheduleSettings: :class:`Tencentcloud::Tat.v20201028.models.ScheduleSettings`
|
1374
|
+
|
1375
|
+
attr_accessor :InvokerId, :Name, :Type, :CommandId, :Username, :Parameters, :InstanceIds, :ScheduleSettings
|
1376
|
+
|
1377
|
+
def initialize(invokerid=nil, name=nil, type=nil, commandid=nil, username=nil, parameters=nil, instanceids=nil, schedulesettings=nil)
|
1378
|
+
@InvokerId = invokerid
|
1379
|
+
@Name = name
|
1380
|
+
@Type = type
|
1381
|
+
@CommandId = commandid
|
1382
|
+
@Username = username
|
1383
|
+
@Parameters = parameters
|
1384
|
+
@InstanceIds = instanceids
|
1385
|
+
@ScheduleSettings = schedulesettings
|
1386
|
+
end
|
1387
|
+
|
1388
|
+
def deserialize(params)
|
1389
|
+
@InvokerId = params['InvokerId']
|
1390
|
+
@Name = params['Name']
|
1391
|
+
@Type = params['Type']
|
1392
|
+
@CommandId = params['CommandId']
|
1393
|
+
@Username = params['Username']
|
1394
|
+
@Parameters = params['Parameters']
|
1395
|
+
@InstanceIds = params['InstanceIds']
|
1396
|
+
unless params['ScheduleSettings'].nil?
|
1397
|
+
@ScheduleSettings = ScheduleSettings.new
|
1398
|
+
@ScheduleSettings.deserialize(params['ScheduleSettings'])
|
1399
|
+
end
|
1400
|
+
end
|
1401
|
+
end
|
1402
|
+
|
1403
|
+
# ModifyInvoker返回参数结构体
|
1404
|
+
class ModifyInvokerResponse < TencentCloud::Common::AbstractModel
|
1405
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1406
|
+
# @type RequestId: String
|
1407
|
+
|
1408
|
+
attr_accessor :RequestId
|
1409
|
+
|
1410
|
+
def initialize(requestid=nil)
|
1411
|
+
@RequestId = requestid
|
1412
|
+
end
|
1413
|
+
|
1414
|
+
def deserialize(params)
|
1415
|
+
@RequestId = params['RequestId']
|
1416
|
+
end
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
# PreviewReplacedCommandContent请求参数结构体
|
1420
|
+
class PreviewReplacedCommandContentRequest < TencentCloud::Common::AbstractModel
|
1421
|
+
# @param Parameters: 本次预览采用的自定义参数。字段类型为 json encoded string,如:{\"varA\": \"222\"}。
|
1422
|
+
# key 为自定义参数名称,value 为该参数的取值。kv 均为字符串型。
|
1423
|
+
# 自定义参数最多 20 个。
|
1424
|
+
# 自定义参数名称需符合以下规范:字符数目上限 64,可选范围【a-zA-Z0-9-_】。
|
1425
|
+
# 如果将预览的 CommandId 设置过 DefaultParameters,本参数可以为空。
|
1426
|
+
# @type Parameters: String
|
1427
|
+
# @param CommandId: 要进行替换预览的命令,如果有设置过 DefaultParameters,会与 Parameters 进行叠加,后者覆盖前者。
|
1428
|
+
# CommandId 与 Content,必须且只能提供一个。
|
1429
|
+
# @type CommandId: String
|
1430
|
+
# @param Content: 要预览的命令内容,经 Base64 编码,长度不可超过 64KB。
|
1431
|
+
# CommandId 与 Content,必须且只能提供一个。
|
1432
|
+
# @type Content: String
|
1433
|
+
|
1434
|
+
attr_accessor :Parameters, :CommandId, :Content
|
1435
|
+
|
1436
|
+
def initialize(parameters=nil, commandid=nil, content=nil)
|
1437
|
+
@Parameters = parameters
|
1438
|
+
@CommandId = commandid
|
1439
|
+
@Content = content
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
def deserialize(params)
|
1443
|
+
@Parameters = params['Parameters']
|
1444
|
+
@CommandId = params['CommandId']
|
1445
|
+
@Content = params['Content']
|
1446
|
+
end
|
1447
|
+
end
|
1448
|
+
|
1449
|
+
# PreviewReplacedCommandContent返回参数结构体
|
1450
|
+
class PreviewReplacedCommandContentResponse < TencentCloud::Common::AbstractModel
|
1451
|
+
# @param ReplacedContent: 自定义参数替换后的,经Base64编码的命令内容。
|
1452
|
+
# @type ReplacedContent: String
|
1453
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1454
|
+
# @type RequestId: String
|
1455
|
+
|
1456
|
+
attr_accessor :ReplacedContent, :RequestId
|
1457
|
+
|
1458
|
+
def initialize(replacedcontent=nil, requestid=nil)
|
1459
|
+
@ReplacedContent = replacedcontent
|
1460
|
+
@RequestId = requestid
|
1461
|
+
end
|
1462
|
+
|
1463
|
+
def deserialize(params)
|
1464
|
+
@ReplacedContent = params['ReplacedContent']
|
1465
|
+
@RequestId = params['RequestId']
|
1466
|
+
end
|
1467
|
+
end
|
1468
|
+
|
1469
|
+
# 描述单个地域信息
|
1470
|
+
class RegionInfo < TencentCloud::Common::AbstractModel
|
1471
|
+
# @param Region: 地域名称,例如,ap-guangzhou
|
1472
|
+
# @type Region: String
|
1473
|
+
# @param RegionName: 地域描述,例如: 广州
|
1474
|
+
# @type RegionName: String
|
1475
|
+
# @param RegionState: 地域是否可用状态,AVAILABLE 代表可用
|
1476
|
+
# @type RegionState: String
|
1477
|
+
|
1478
|
+
attr_accessor :Region, :RegionName, :RegionState
|
1479
|
+
|
1480
|
+
def initialize(region=nil, regionname=nil, regionstate=nil)
|
1481
|
+
@Region = region
|
1482
|
+
@RegionName = regionname
|
1483
|
+
@RegionState = regionstate
|
1484
|
+
end
|
1485
|
+
|
1486
|
+
def deserialize(params)
|
1487
|
+
@Region = params['Region']
|
1488
|
+
@RegionName = params['RegionName']
|
1489
|
+
@RegionState = params['RegionState']
|
1490
|
+
end
|
1491
|
+
end
|
1492
|
+
|
1493
|
+
# RunCommand请求参数结构体
|
1494
|
+
class RunCommandRequest < TencentCloud::Common::AbstractModel
|
1495
|
+
# @param Content: Base64编码后的命令内容,长度不可超过64KB。
|
1496
|
+
# @type Content: String
|
1497
|
+
# @param InstanceIds: 待执行命令的实例ID列表,上限100。支持实例类型:
|
1498
|
+
# <li> CVM
|
1499
|
+
# <li> LIGHTHOUSE
|
1500
|
+
# @type InstanceIds: Array
|
1501
|
+
# @param CommandName: 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
|
1502
|
+
# @type CommandName: String
|
1503
|
+
# @param Description: 命令描述。不超过120字符。
|
1504
|
+
# @type Description: String
|
1505
|
+
# @param CommandType: 命令类型,目前仅支持取值:SHELL。默认:SHELL。
|
1506
|
+
# @type CommandType: String
|
1507
|
+
# @param WorkingDirectory: 命令执行路径,默认:/root。
|
1508
|
+
# @type WorkingDirectory: String
|
1509
|
+
# @param Timeout: 命令超时时间,默认60秒。取值范围[1, 86400]。
|
1510
|
+
# @type Timeout: Integer
|
1511
|
+
# @param SaveCommand: 是否保存命令,取值范围:
|
1512
|
+
# <li> True:保存
|
1513
|
+
# <li> False:不保存
|
1514
|
+
# 默认为 False。
|
1515
|
+
# @type SaveCommand: Boolean
|
1516
|
+
# @param EnableParameter: 是否启用自定义参数功能。
|
1517
|
+
# 一旦创建,此值不提供修改。
|
1518
|
+
# 默认值:false。
|
1519
|
+
# @type EnableParameter: Boolean
|
1520
|
+
# @param DefaultParameters: 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。
|
1521
|
+
# key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
1522
|
+
# 如果 Parameters 未提供,将使用这里的默认值进行替换。
|
1523
|
+
# 自定义参数最多20个。
|
1524
|
+
# 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
1525
|
+
# @type DefaultParameters: String
|
1526
|
+
# @param Parameters: Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
|
1527
|
+
# key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
|
1528
|
+
# 如果未提供该参数取值,将使用 DefaultParameters 进行替换。
|
1529
|
+
# 自定义参数最多20个。
|
1530
|
+
# 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
|
1531
|
+
# @type Parameters: String
|
1532
|
+
# @param Tags: 如果保存命令,可为命令设置标签。列表长度不超过10。
|
1533
|
+
# @type Tags: Array
|
1534
|
+
# @param Username: 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
|
1535
|
+
# 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在Linux实例中以root用户执行命令。
|
1536
|
+
# @type Username: String
|
1537
|
+
|
1538
|
+
attr_accessor :Content, :InstanceIds, :CommandName, :Description, :CommandType, :WorkingDirectory, :Timeout, :SaveCommand, :EnableParameter, :DefaultParameters, :Parameters, :Tags, :Username
|
1539
|
+
|
1540
|
+
def initialize(content=nil, instanceids=nil, commandname=nil, description=nil, commandtype=nil, workingdirectory=nil, timeout=nil, savecommand=nil, enableparameter=nil, defaultparameters=nil, parameters=nil, tags=nil, username=nil)
|
1541
|
+
@Content = content
|
1542
|
+
@InstanceIds = instanceids
|
1543
|
+
@CommandName = commandname
|
1544
|
+
@Description = description
|
1545
|
+
@CommandType = commandtype
|
1546
|
+
@WorkingDirectory = workingdirectory
|
1547
|
+
@Timeout = timeout
|
1548
|
+
@SaveCommand = savecommand
|
1549
|
+
@EnableParameter = enableparameter
|
1550
|
+
@DefaultParameters = defaultparameters
|
1551
|
+
@Parameters = parameters
|
1552
|
+
@Tags = tags
|
1553
|
+
@Username = username
|
1554
|
+
end
|
1555
|
+
|
1556
|
+
def deserialize(params)
|
1557
|
+
@Content = params['Content']
|
1558
|
+
@InstanceIds = params['InstanceIds']
|
1559
|
+
@CommandName = params['CommandName']
|
1560
|
+
@Description = params['Description']
|
1561
|
+
@CommandType = params['CommandType']
|
1562
|
+
@WorkingDirectory = params['WorkingDirectory']
|
1563
|
+
@Timeout = params['Timeout']
|
1564
|
+
@SaveCommand = params['SaveCommand']
|
1565
|
+
@EnableParameter = params['EnableParameter']
|
1566
|
+
@DefaultParameters = params['DefaultParameters']
|
1567
|
+
@Parameters = params['Parameters']
|
1568
|
+
unless params['Tags'].nil?
|
1569
|
+
@Tags = []
|
1570
|
+
params['Tags'].each do |i|
|
1571
|
+
tag_tmp = Tag.new
|
1572
|
+
tag_tmp.deserialize(i)
|
1573
|
+
@Tags << tag_tmp
|
1574
|
+
end
|
1575
|
+
end
|
1576
|
+
@Username = params['Username']
|
1577
|
+
end
|
1578
|
+
end
|
1579
|
+
|
1580
|
+
# RunCommand返回参数结构体
|
1581
|
+
class RunCommandResponse < TencentCloud::Common::AbstractModel
|
1582
|
+
# @param CommandId: 命令ID。
|
1583
|
+
# @type CommandId: String
|
1584
|
+
# @param InvocationId: 执行活动ID。
|
1585
|
+
# @type InvocationId: String
|
1586
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1587
|
+
# @type RequestId: String
|
1588
|
+
|
1589
|
+
attr_accessor :CommandId, :InvocationId, :RequestId
|
1590
|
+
|
1591
|
+
def initialize(commandid=nil, invocationid=nil, requestid=nil)
|
1592
|
+
@CommandId = commandid
|
1593
|
+
@InvocationId = invocationid
|
1594
|
+
@RequestId = requestid
|
1595
|
+
end
|
1596
|
+
|
1597
|
+
def deserialize(params)
|
1598
|
+
@CommandId = params['CommandId']
|
1599
|
+
@InvocationId = params['InvocationId']
|
1600
|
+
@RequestId = params['RequestId']
|
1601
|
+
end
|
1602
|
+
end
|
1603
|
+
|
1604
|
+
# 周期执行器设置。
|
1605
|
+
class ScheduleSettings < TencentCloud::Common::AbstractModel
|
1606
|
+
# @param Policy: 执行策略:
|
1607
|
+
# <br><li>ONCE:单次执行
|
1608
|
+
# <br><li>RECURRENCE:周期执行
|
1609
|
+
# @type Policy: String
|
1610
|
+
# @param Recurrence: 触发 Crontab 表达式。Policy 为 RECURRENCE 时,需要指定此字段。Crontab 按北京时间解析。
|
1611
|
+
# @type Recurrence: String
|
1612
|
+
# @param InvokeTime: 执行器下次执行时间。Policy 为 ONCE 时,需要指定此字段。
|
1613
|
+
# @type InvokeTime: String
|
1614
|
+
|
1615
|
+
attr_accessor :Policy, :Recurrence, :InvokeTime
|
1616
|
+
|
1617
|
+
def initialize(policy=nil, recurrence=nil, invoketime=nil)
|
1618
|
+
@Policy = policy
|
1619
|
+
@Recurrence = recurrence
|
1620
|
+
@InvokeTime = invoketime
|
1621
|
+
end
|
1622
|
+
|
1623
|
+
def deserialize(params)
|
1624
|
+
@Policy = params['Policy']
|
1625
|
+
@Recurrence = params['Recurrence']
|
1626
|
+
@InvokeTime = params['InvokeTime']
|
1627
|
+
end
|
1628
|
+
end
|
1629
|
+
|
1630
|
+
# 标签
|
1631
|
+
class Tag < TencentCloud::Common::AbstractModel
|
1632
|
+
# @param Key: 标签键。
|
1633
|
+
# @type Key: String
|
1634
|
+
# @param Value: 标签值。
|
1635
|
+
# @type Value: String
|
1636
|
+
|
1637
|
+
attr_accessor :Key, :Value
|
1638
|
+
|
1639
|
+
def initialize(key=nil, value=nil)
|
1640
|
+
@Key = key
|
1641
|
+
@Value = value
|
1642
|
+
end
|
1643
|
+
|
1644
|
+
def deserialize(params)
|
1645
|
+
@Key = params['Key']
|
1646
|
+
@Value = params['Value']
|
1647
|
+
end
|
1648
|
+
end
|
1649
|
+
|
1650
|
+
# 任务结果。
|
1651
|
+
class TaskResult < TencentCloud::Common::AbstractModel
|
1652
|
+
# @param ExitCode: 命令执行ExitCode。
|
1653
|
+
# @type ExitCode: Integer
|
1654
|
+
# @param Output: Base64编码后的命令输出。最大长度24KB。
|
1655
|
+
# @type Output: String
|
1656
|
+
# @param ExecStartTime: 命令执行开始时间。
|
1657
|
+
# @type ExecStartTime: String
|
1658
|
+
# @param ExecEndTime: 命令执行结束时间。
|
1659
|
+
# @type ExecEndTime: String
|
1660
|
+
# @param Dropped: 命令最终输出被截断的字节数。
|
1661
|
+
# @type Dropped: Integer
|
1662
|
+
|
1663
|
+
attr_accessor :ExitCode, :Output, :ExecStartTime, :ExecEndTime, :Dropped
|
1664
|
+
|
1665
|
+
def initialize(exitcode=nil, output=nil, execstarttime=nil, execendtime=nil, dropped=nil)
|
1666
|
+
@ExitCode = exitcode
|
1667
|
+
@Output = output
|
1668
|
+
@ExecStartTime = execstarttime
|
1669
|
+
@ExecEndTime = execendtime
|
1670
|
+
@Dropped = dropped
|
1671
|
+
end
|
1672
|
+
|
1673
|
+
def deserialize(params)
|
1674
|
+
@ExitCode = params['ExitCode']
|
1675
|
+
@Output = params['Output']
|
1676
|
+
@ExecStartTime = params['ExecStartTime']
|
1677
|
+
@ExecEndTime = params['ExecEndTime']
|
1678
|
+
@Dropped = params['Dropped']
|
1679
|
+
end
|
1680
|
+
end
|
1681
|
+
|
1682
|
+
end
|
1683
|
+
end
|
1684
|
+
end
|
1685
|
+
|