Class: QingCloud::SDK::InstanceService

Inherits:
Object
  • Object
show all
Defined in:
lib/qingcloud/sdk/service/instance.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, properties) ⇒ InstanceService

Returns a new instance of InstanceService.



24
25
26
27
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 24

def initialize(config, properties)
  self.config     = config
  self.properties = properties.deep_symbolize_keys
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



22
23
24
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 22

def config
  @config
end

#properties ⇒ Object

Returns the value of attribute properties.



22
23
24
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 22

def properties
  @properties
end

Instance Method Details

#describe_instance_types(instance_types: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/describe_instance_types.html



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 30

def describe_instance_types(instance_types: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DescribeInstanceTypes',
    request_method: 'GET',
    request_params: {
      'instance_types' => instance_types,
    },
  }

  describe_instance_types_input_validate input

  request = Request.new input
  request.send
end

#describe_instances(image_id: [], instance_class: nil, instance_type: [], instances: [], limit: nil, offset: nil, search_word: '', status: [], tags: [], verbose: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/describe_instances.html



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 56

def describe_instances(image_id: [], instance_class: nil, instance_type: [], instances: [], limit: nil, offset: nil, search_word: '', status: [], tags: [], verbose: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DescribeInstances',
    request_method: 'GET',
    request_params: {
      'image_id'       => image_id,
      'instance_class' => instance_class, # instance_class's available values: 0, 1
      'instance_type'  => instance_type,
      'instances'      => instances,
      'limit'          => limit,
      'offset'         => offset,
      'search_word'    => search_word,
      'status'         => status,
      'tags'           => tags,
      'verbose'        => verbose, # verbose's available values: 0, 1
    },
  }

  describe_instances_input_validate input

  request = Request.new input
  request.send
end

#get_instance_monitor(end_time: '', meters: [], resource: '', start_time: '', step: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/monitor/get_monitor.html



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 113

def get_instance_monitor(end_time: '', meters: [], resource: '', start_time: '', step: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'GetMonitor',
    request_method: 'GET',
    request_params: {
      'end_time'   => end_time,
      'meters'     => meters,
      'resource'   => resource,
      'start_time' => start_time,
      'step'       => step, # step's available values: 5m, 15m, 2h, 1d
    },
  }

  get_instance_monitor_input_validate input

  request = Request.new input
  request.send
end

#modify_instance_attributes(description: '', instance: '', instance_name: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/modify_instance_attributes.html



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 174

def modify_instance_attributes(description: '', instance: '', instance_name: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ModifyInstanceAttributes',
    request_method: 'GET',
    request_params: {
      'description'   => description,
      'instance'      => instance,
      'instance_name' => instance_name,
    },
  }

  modify_instance_attributes_input_validate input

  request = Request.new input
  request.send
end

#reset_instances(instances: [], login_keypair: '', login_mode: '', login_passwd: '', need_newsid: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/reset_instances.html



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 206

def reset_instances(instances: [], login_keypair: '', login_mode: '', login_passwd: '', need_newsid: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ResetInstances',
    request_method: 'GET',
    request_params: {
      'instances'     => instances,
      'login_keypair' => ,
      'login_mode'    => , # login_mode's available values: keypair, passwd
      'login_passwd'  => ,
      'need_newsid'   => need_newsid, # need_newsid's available values: 0, 1
    },
  }

  reset_instances_input_validate input

  request = Request.new input
  request.send
end

#resize_instances(cpu: nil, instance_type: '', instances: [], memory: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/resize_instances.html



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 266

def resize_instances(cpu: nil, instance_type: '', instances: [], memory: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ResizeInstances',
    request_method: 'GET',
    request_params: {
      'cpu'           => cpu, # cpu's available values: 1, 2, 4, 8, 16
      'instance_type' => instance_type,
      'instances'     => instances,
      'memory'        => memory, # memory's available values: 1024, 2048, 4096, 6144, 8192, 12288, 16384, 24576, 32768
    },
  }

  resize_instances_input_validate input

  request = Request.new input
  request.send
end

#restart_instances(instances: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/restart_instances.html



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 321

def restart_instances(instances: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'RestartInstances',
    request_method: 'GET',
    request_params: {
      'instances' => instances,
    },
  }

  restart_instances_input_validate input

  request = Request.new input
  request.send
end

#run_instances(billing_id: '', count: nil, cpu: nil, hostname: '', image_id: '', instance_class: nil, instance_name: '', instance_type: '', login_keypair: '', login_mode: '', login_passwd: '', memory: nil, need_newsid: nil, need_userdata: nil, security_group: '', ui_type: '', userdata_file: '', userdata_path: '', userdata_type: '', userdata_value: '', volumes: [], vxnets: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/run_instances.html



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 351

def run_instances(billing_id: '', count: nil, cpu: nil, hostname: '', image_id: '', instance_class: nil, instance_name: '', instance_type: '', login_keypair: '', login_mode: '', login_passwd: '', memory: nil, need_newsid: nil, need_userdata: nil, security_group: '', ui_type: '', userdata_file: '', userdata_path: '', userdata_type: '', userdata_value: '', volumes: [], vxnets: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'RunInstances',
    request_method: 'GET',
    request_params: {
      'billing_id'     => billing_id,
      'count'          => count,
      'cpu'            => cpu, # cpu's available values: 1, 2, 4, 8, 16
      'hostname'       => hostname,
      'image_id'       => image_id,
      'instance_class' => instance_class, # instance_class's available values: 0, 1
      'instance_name'  => instance_name,
      'instance_type'  => instance_type,
      'login_keypair'  => ,
      'login_mode'     => , # login_mode's available values: keypair, passwd
      'login_passwd'   => ,
      'memory'         => memory, # memory's available values: 1024, 2048, 4096, 6144, 8192, 12288, 16384, 24576, 32768
      'need_newsid'    => need_newsid, # need_newsid's available values: 0, 1
      'need_userdata'  => need_userdata,  # need_userdata's available values: 0, 1
      'security_group' => security_group,
      'ui_type'        => ui_type,
      'userdata_file'  => userdata_file,
      'userdata_path'  => userdata_path,
      'userdata_type'  => userdata_type,  # userdata_type's available values: plain, exec, tar
      'userdata_value' => userdata_value,
      'volumes'        => volumes,
      'vxnets'         => vxnets,
    },
  }

  run_instances_input_validate input

  request = Request.new input
  request.send
end

#start_instances(instances: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/start_instances.html



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 483

def start_instances(instances: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'StartInstances',
    request_method: 'GET',
    request_params: {
      'instances' => instances,
    },
  }

  start_instances_input_validate input

  request = Request.new input
  request.send
end

#stop_instances(force: nil, instances: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/stop_instances.html



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 513

def stop_instances(force: nil, instances: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'StopInstances',
    request_method: 'GET',
    request_params: {
      'force'     => force, # force's available values: 0, 1
      'instances' => instances,
    },
  }

  stop_instances_input_validate input

  request = Request.new input
  request.send
end

#terminate_instances(instances: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/instance/terminate_instances.html



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/qingcloud/sdk/service/instance.rb', line 555

def terminate_instances(instances: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'TerminateInstances',
    request_method: 'GET',
    request_params: {
      'instances' => instances,
    },
  }

  terminate_instances_input_validate input

  request = Request.new input
  request.send
end