Class: QingCloud::SDK::CacheService

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, properties) ⇒ CacheService

Returns a new instance of CacheService.



24
25
26
27
 
# File 'lib/qingcloud/sdk/service/cache.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/cache.rb', line 22

def config
  @config
end

#properties ⇒ Object

Returns the value of attribute properties.



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

def properties
  @properties
end

Instance Method Details

#add_cache_nodes(cache: '', node_count: nil, private_ips: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/add_cache_nodes.html



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

def add_cache_nodes(cache: '', node_count: nil, private_ips: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'AddCacheNodes',
    request_method: 'GET',
    request_params: {
      'cache'       => cache,
      'node_count'  => node_count,
      'private_ips' => private_ips,
    },
  }

  add_cache_nodes_input_validate input

  request = Request.new input
  request.send
end

#apply_cache_parameter_group(cache_parameter_group: '', caches: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/apply_cache_parameter_group.html



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 77

def apply_cache_parameter_group(cache_parameter_group: '', caches: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ApplyCacheParameterGroup',
    request_method: 'GET',
    request_params: {
      'cache_parameter_group' => cache_parameter_group,
      'caches'                => caches,
    },
  }

  apply_cache_parameter_group_input_validate input

  request = Request.new input
  request.send
end

#change_cache_vxnet(cache: '', private_ips: [], vxnet: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/change_cache_vxnet.html



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 108

def change_cache_vxnet(cache: '', private_ips: [], vxnet: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ChangeCacheVxnet',
    request_method: 'GET',
    request_params: {
      'cache'       => cache,
      'private_ips' => private_ips,
      'vxnet'       => vxnet,
    },
  }

  change_cache_vxnet_input_validate input

  request = Request.new input
  request.send
end

#create_cache(auto_backup_time: nil, cache_class: nil, cache_name: '', cache_parameter_group: '', cache_size: nil, cache_type: '', master_count: nil, network_type: nil, node_count: nil, private_ips: [], replicate_count: nil, vxnet: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/create_cache.html



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 155

def create_cache(auto_backup_time: nil, cache_class: nil, cache_name: '', cache_parameter_group: '', cache_size: nil, cache_type: '', master_count: nil, network_type: nil, node_count: nil, private_ips: [], replicate_count: nil, vxnet: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'CreateCache',
    request_method: 'GET',
    request_params: {
      'auto_backup_time'      => auto_backup_time,
      'cache_class'           => cache_class, # cache_class's available values: 0, 1
      'cache_name'            => cache_name,
      'cache_parameter_group' => cache_parameter_group,
      'cache_size'            => cache_size,
      'cache_type'            => cache_type,
      'master_count'          => master_count,
      'network_type'          => network_type,
      'node_count'            => node_count,
      'private_ips'           => private_ips,
      'replicate_count'       => replicate_count,
      'vxnet'                 => vxnet,
    },
  }

  create_cache_input_validate input

  request = Request.new input
  request.send
end

#create_cache_from_snapshot(auto_backup_time: nil, cache_class: nil, cache_name: '', cache_parameter_group: '', cache_size: nil, cache_type: '', network_type: nil, node_count: nil, private_ips: [], snapshot: '', vxnet: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/create_cache_from_snapshot.html



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 226

def create_cache_from_snapshot(auto_backup_time: nil, cache_class: nil, cache_name: '', cache_parameter_group: '', cache_size: nil, cache_type: '', network_type: nil, node_count: nil, private_ips: [], snapshot: '', vxnet: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'CreateCacheFromSnapshot',
    request_method: 'GET',
    request_params: {
      'auto_backup_time'      => auto_backup_time,
      'cache_class'           => cache_class, # cache_class's available values: 0, 1
      'cache_name'            => cache_name,
      'cache_parameter_group' => cache_parameter_group,
      'cache_size'            => cache_size,
      'cache_type'            => cache_type,
      'network_type'          => network_type,
      'node_count'            => node_count,
      'private_ips'           => private_ips,
      'snapshot'              => snapshot,
      'vxnet'                 => vxnet,
    },
  }

  create_cache_from_snapshot_input_validate input

  request = Request.new input
  request.send
end

#create_cache_parameter_group(cache_parameter_group_name: '', cache_type: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/create_cache_parameter_group.html



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 292

def create_cache_parameter_group(cache_parameter_group_name: '', cache_type: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'CreateCacheParameterGroup',
    request_method: 'GET',
    request_params: {
      'cache_parameter_group_name' => cache_parameter_group_name,
      'cache_type'                 => cache_type, # cache_type's available values: redis2.8.17, memcached1.4.13
    },
  }

  create_cache_parameter_group_input_validate input

  request = Request.new input
  request.send
end

#delete_cache_nodes(cache: '', cache_nodes: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/delete_cache_nodes.html



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 334

def delete_cache_nodes(cache: '', cache_nodes: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DeleteCacheNodes',
    request_method: 'GET',
    request_params: {
      'cache'       => cache,
      'cache_nodes' => cache_nodes,
    },
  }

  delete_cache_nodes_input_validate input

  request = Request.new input
  request.send
end

#delete_cache_parameter_groups(cache_parameter_groups: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/delete_cache_parameter_groups.html



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 369

def delete_cache_parameter_groups(cache_parameter_groups: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DeleteCacheParameterGroups',
    request_method: 'GET',
    request_params: {
      'cache_parameter_groups' => cache_parameter_groups,
    },
  }

  delete_cache_parameter_groups_input_validate input

  request = Request.new input
  request.send
end

#delete_caches(caches: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/delete_caches.html



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 399

def delete_caches(caches: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DeleteCaches',
    request_method: 'GET',
    request_params: {
      'caches' => caches,
    },
  }

  delete_caches_input_validate input

  request = Request.new input
  request.send
end

#describe_cache_nodes(cache: '', cache_nodes: [], limit: nil, offset: nil, search_word: '', status: [], verbose: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/describe_cache_nodes.html



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 429

def describe_cache_nodes(cache: '', cache_nodes: [], limit: nil, offset: nil, search_word: '', status: [], verbose: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DescribeCacheNodes',
    request_method: 'GET',
    request_params: {
      'cache'       => cache,
      'cache_nodes' => cache_nodes,
      'limit'       => limit,
      'offset'      => offset,
      'search_word' => search_word,
      'status'      => status,
      'verbose'     => verbose,
    },
  }

  describe_cache_nodes_input_validate input

  request = Request.new input
  request.send
end

#describe_cache_parameter_groups(cache_parameter_groups: [], cache_type: '', limit: nil, offset: nil, search_word: '', verbose: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/describe_cache_parameter_groups.html



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 461

def describe_cache_parameter_groups(cache_parameter_groups: [], cache_type: '', limit: nil, offset: nil, search_word: '', verbose: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DescribeCacheParameterGroups',
    request_method: 'GET',
    request_params: {
      'cache_parameter_groups' => cache_parameter_groups,
      'cache_type'             => cache_type,
      'limit'                  => limit,
      'offset'                 => offset,
      'search_word'            => search_word,
      'verbose'                => verbose,
    },
  }

  describe_cache_parameter_groups_input_validate input

  request = Request.new input
  request.send
end

#describe_cache_parameters(cache_parameter_group: '', verbose: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/describe_cache_parameters.html



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 492

def describe_cache_parameters(cache_parameter_group: '', verbose: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DescribeCacheParameters',
    request_method: 'GET',
    request_params: {
      'cache_parameter_group' => cache_parameter_group,
      'verbose'               => verbose,
    },
  }

  describe_cache_parameters_input_validate input

  request = Request.new input
  request.send
end

#describe_caches(cache_type: [], caches: [], limit: nil, offset: nil, search_word: '', status: [], tags: [], verbose: nil) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/describe_caches.html



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 523

def describe_caches(cache_type: [], caches: [], limit: nil, offset: nil, search_word: '', status: [], tags: [], verbose: nil)
  input = {
    config:         config,
    properties:     properties,
    api_name:       'DescribeCaches',
    request_method: 'GET',
    request_params: {
      'cache_type'  => cache_type,
      'caches'      => caches,
      'limit'       => limit,
      'offset'      => offset,
      'search_word' => search_word,
      'status'      => status,
      'tags'        => tags,
      'verbose'     => verbose,
    },
  }

  describe_caches_input_validate input

  request = Request.new input
  request.send
end

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

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



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 556

def get_cache_monitor(end_time: '', meters: [], resource: '', start_time: '', step: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'GetCacheMonitor',
    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_cache_monitor_input_validate input

  request = Request.new input
  request.send
end

#modify_cache_attributes(auto_backup_time: nil, cache: '', cache_name: '', description: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/modify_cache_attributes.html



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 617

def modify_cache_attributes(auto_backup_time: nil, cache: '', cache_name: '', description: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ModifyCacheAttributes',
    request_method: 'GET',
    request_params: {
      'auto_backup_time' => auto_backup_time,
      'cache'            => cache,
      'cache_name'       => cache_name,
      'description'      => description,
    },
  }

  modify_cache_attributes_input_validate input

  request = Request.new input
  request.send
end

#modify_cache_node_attributes(cache_node: '', cache_node_name: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/modify_cache_node_attributes.html



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 650

def modify_cache_node_attributes(cache_node: '', cache_node_name: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ModifyCacheNodeAttributes',
    request_method: 'GET',
    request_params: {
      'cache_node'      => cache_node,
      'cache_node_name' => cache_node_name,
    },
  }

  modify_cache_node_attributes_input_validate input

  request = Request.new input
  request.send
end

#modify_cache_parameter_group_attributes(cache_parameter_group: '', cache_parameter_group_name: '', description: '') ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/modify_cache_parameter_group_attributes.html



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 681

def modify_cache_parameter_group_attributes(cache_parameter_group: '', cache_parameter_group_name: '', description: '')
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ModifyCacheParameterGroupAttributes',
    request_method: 'GET',
    request_params: {
      'cache_parameter_group'      => cache_parameter_group,
      'cache_parameter_group_name' => cache_parameter_group_name,
      'description'                => description,
    },
  }

  modify_cache_parameter_group_attributes_input_validate input

  request = Request.new input
  request.send
end

#reset_cache_parameters(cache_parameter_group: '', cache_parameter_names: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/reset_cache_parameters.html



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 713

def reset_cache_parameters(cache_parameter_group: '', cache_parameter_names: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ResetCacheParameters',
    request_method: 'GET',
    request_params: {
      'cache_parameter_group' => cache_parameter_group,
      'cache_parameter_names' => cache_parameter_names,
    },
  }

  reset_cache_parameters_input_validate input

  request = Request.new input
  request.send
end

#resize_caches(cache_size: nil, caches: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/resize_cache.html



744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 744

def resize_caches(cache_size: nil, caches: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'ResizeCaches',
    request_method: 'GET',
    request_params: {
      'cache_size' => cache_size,
      'caches'     => caches,
    },
  }

  resize_caches_input_validate input

  request = Request.new input
  request.send
end

#restart_cache_nodes(cache: '', cache_nodes: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/restart_cache_nodes.html



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 779

def restart_cache_nodes(cache: '', cache_nodes: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'RestartCacheNodes',
    request_method: 'GET',
    request_params: {
      'cache'       => cache,
      'cache_nodes' => cache_nodes,
    },
  }

  restart_cache_nodes_input_validate input

  request = Request.new input
  request.send
end

#restart_caches(caches: []) ⇒ Object

restart_caches: Only available for memcached. Documentation URL: docs.qingcloud.com/api/cache/restart_caches.html



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 815

def restart_caches(caches: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'RestartCaches',
    request_method: 'GET',
    request_params: {
      'caches' => caches,
    },
  }

  restart_caches_input_validate input

  request = Request.new input
  request.send
end

#start_caches(caches: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/start_caches.html



845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 845

def start_caches(caches: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'StartCaches',
    request_method: 'GET',
    request_params: {
      'caches' => caches,
    },
  }

  start_caches_input_validate input

  request = Request.new input
  request.send
end

#stop_caches(caches: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/stop_caches.html



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 875

def stop_caches(caches: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'StopCaches',
    request_method: 'GET',
    request_params: {
      'caches' => caches,
    },
  }

  stop_caches_input_validate input

  request = Request.new input
  request.send
end

#update_cache(cache: '', private_ips: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/update_cache.html



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 905

def update_cache(cache: '', private_ips: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'UpdateCache',
    request_method: 'GET',
    request_params: {
      'cache'       => cache,
      'private_ips' => private_ips,
    },
  }

  update_cache_input_validate input

  request = Request.new input
  request.send
end

#update_cache_parameters(cache_parameter_group: '', parameters: []) ⇒ Object

Documentation URL: docs.qingcloud.com/api/cache/update_cache_parameters.html



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/qingcloud/sdk/service/cache.rb', line 947

def update_cache_parameters(cache_parameter_group: '', parameters: [])
  input = {
    config:         config,
    properties:     properties,
    api_name:       'UpdateCacheParameters',
    request_method: 'GET',
    request_params: {
      'cache_parameter_group' => cache_parameter_group,
      'parameters'            => parameters,
    },
  }

  update_cache_parameters_input_validate input

  request = Request.new input
  request.send
end