mos_sdk 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3062a341e10d50c0ba53d12da98907ab862f1af2
+  data.tar.gz: 0f471fcf2b040f8e479eefcf633adc72bef26b1c
+SHA512:
+  metadata.gz: a4e495643cc5c6aef94d7a01be978568359b2398ade1e1174bb9bb3dd51ada331e946c968ab6724a47f4efabb8ef99a30b96ee941e8b4473c9215e743ab522cd
+  data.tar.gz: 7784e038edbe6f6a7332a492a97fe3eefb3b2a31b08d13e687dd95d3bad5217d117919f2c9b338d2188c2f2b1ea4704f38bcef1c5ce119cfcdd284f22e78709d

data/lib/mos_sdk.rb

@@ -0,0 +1,315 @@
+# -*- coding: utf-8 -*-
+$:.unshift File.join(File.dirname(__FILE__), '.', 'mos_sdk')
+require 'base.rb'
+
+module MosSdk
+  class Client < MosSdk::Base
+  end
+end
+
+# 基类函数为Base，mos_sdk的实现类
+class MosSdk::Client
+  # 构造函数
+  def initialize(access, secret, url, format='xml', timeout=300, debug=false)
+    super(access, secret, url, format, timeout, debug)
+  end
+
+  # 获取所有虚拟机类型
+  # - @param [Integer] limit 最大返回数量，用于分页控制
+  # - @param [Integer] offset 返回偏移量，用于分页控制
+  # - @param [Hash] filters 过滤条件，key/value分别指定过滤字段名称和值，支持的字段名称为：name, status
+  # - @return [Hash] 所有虚拟机信息
+  def describe_instance_types(limit=0, offset=0, filters=nil)
+    kwargs = {}
+    self.parse_array_params(limit, offset, filters, kwargs) # parse_list_params  父类函数
+    val = self.request('DescribeInstanceTypes', *kwargs)
+    val['InstanceTypeSet']
+  end
+
+  # 获得所有虚拟机模板
+  # - @return [Hash] 模板列表
+  def describe_templates()
+    val = self.request('DescribeTemplates')
+    val['TemplateSet']
+  end
+
+  # 获取帐户余额和最近更新时间
+  # - @return [Hash] 帐户余额和最近更新时间
+  def get_balance()
+    self.request('GetBalance')
+  end
+
+  # 获得所有虚拟机
+  # - @param [Array] ids 期望获取的虚拟机ID列表
+  # - @param [Array] names 期望获取信息的虚拟机名称列表
+  # - @param [Integer] limit  最多返回数量
+  # - @param [Integer] offset 返回虚拟机的偏移量，用于分页显示
+  # - @param [Hash] filters  过滤器，一个hash，包含过滤字段名和值，可能过滤字段为：name, status
+  # - @return [Hash] 虚拟机列表
+  def describe_instances(ids=nil, names=nil, limit=0, offset=0, filters=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = ids if ids.kind_of?(Array) && ids.size() > 0
+    kwargs['InstanceName'] = names if names.kind_of?(Array) && names.size() > 0
+    self.parse_array_params(limit, offset, filters, kwargs)
+    val = self.request('DescribeInstances', *kwargs)
+    val['InstanceSet']
+  end
+
+  # 获取指定虚拟机的虚拟磁盘信息
+  # - @param [String] iid  虚拟机ID
+  # - @param [Integer] limit  最大返回数量，用于分页控制
+  # - @param [Integer] offset 返回的偏移量，用于分页控制
+  # - @param [Hash] filters 返回结果过滤条件，由hash的key/value指定过滤字段名和值
+  # - @return [Hash] 指定虚拟机磁盘列表
+  def describe_instance_volumes(iid, limit=0, offset=0, filters=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    self.parse_array_params(limit, offset, filters, kwargs)
+    val = self.request('DescribeInstanceVolumes', *kwargs)
+    val['InstanceVolumeSet']
+  end
+
+  # 获取指定虚拟机的网络接口（虚拟网卡）信息
+  # - @param [String] iid 虚拟机ID
+  # - @param [Integer] limit 最大返回数量，用于分页控制
+  # - @param [Integer] offset 返回的偏移量，用于分页控制
+  # - @param [Hash] filters 返回结果过滤条件，由hash的key/value指定过滤字段名和值
+  # - @return [Hash] 指定虚拟机的网络接口（虚拟网卡）信息
+  def describe_network_interfaces(iid, limit=0, offset=0, filters=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    self.parse_array_params(limit, offset, filters, kwargs)
+    val = self.request('DescribeInstanceNetworkInterfaces', *kwargs)
+    val['InstanceNetworkInterfaceSet']
+  end
+
+  # 虚拟机租期续费
+  # - @param [String] iid  虚拟机ID
+  # - @param [String] duration 续费租期，缺省为'1M'，即一个月
+  def renew_instance(iid, duration=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    unless duration.nil?
+      (/^\d+[HhMm]$/.match(duration)) ? (kwargs['Duration'] = duration) : (raise Exception("Illegal duration %s" % duration))
+    end
+    self.request('RenewInstance', *kwargs)
+  end
+
+  # 获取虚拟机的租期信息
+  # - @param [String] iid  虚拟机ID
+  # - @return [Hash]  虚拟机租期信息，包含过期时间、自动删除时间
+  def get_instance_contract_info(iid)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    self.request('GetInstanceContractInfo', *kwargs)
+  end
+
+  # 创建虚拟机,创建时要提供datadisk和bandwidth参数
+  # - @param [String] imageid 系统模板ID
+  # - @param [String] itype 虚拟机类型ID  例如 C4_M4 代表四核 4G内存
+  # - @param [String] duration 虚拟机租期, 缺省为'1M'，即一个月
+  # - @param [String] name 虚拟机名称(可选)
+  # - @param [String] keypair 虚拟机使用的SSH密钥ID
+  # - @param [Integer] datadisk 指定创建虚拟机使用的额外数据盘，单位为1GB
+  # - @param [Integer] bandwidth 指定创建虚拟机使用的额外带宽，单位为Mbps
+  # - @return [Hash]   创建成功的虚拟机信息
+  def create_instance(imageid, itype, duration=nil, name=nil, keypair=nil, datadisk=nil, bandwidth=nil)
+    kwargs = {}
+    kwargs['ImageId'] = imageid
+    kwargs['InstanceType'] = itype
+    unless duration.nil?
+      /^\d+[HhMm]$/.match(duration) ? kwargs['Duration'] = duration : (raise Exception('Illegal duration format'))
+    end
+
+    kwargs['InstanceName'] = name unless name.nil?
+    kwargs['KeyName'] = keypair unless keypair.nil?
+    kwargs['ExtraExtDisksize'] = datadisk unless datadisk.nil?
+    kwargs['ExtraExtBandwidth'] = bandwidth unless bandwidth.nil?
+    val = self.request('CreateInstance', *kwargs)
+    val['Instance']
+  end
+
+  # 获取虚拟机的状态
+  # - @param [String] iid 虚拟机ID
+  # - @return [Hash] 虚拟机状态
+  def describe_instance_status(iid)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    val = self.request('DescribeInstanceStatus', *kwargs)
+    val['InstanceStatus']
+  end
+
+  # 获取虚拟机的Login帐户信息
+  # - @param [String] iid 虚拟机ID
+  # - @param [String] key_file 私钥文件路径，如果虚拟机使用了SSH密钥，需要指定私钥解密password
+  # - @return [Hash] 虚拟机Login信息，包含帐户名称、密码，如果使用SSH密钥，则还包含密钥ID和名称
+  def get_password_data(iid, key_file=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    val = self.request('GetPasswordData', *kwargs)
+    if val.has_key?('passwordData') && val.has_key?('keypairName')
+      if key_file.nil?
+        raise Exception('Password is encrypted, please specify private key of keypair %s' % val['keypairName'])
+      else
+        begin
+          f = open(key_file)
+        rescue
+          puts 'fail to open file'
+          exit(-1)
+        end
+
+        key = f.read()
+        f.close()
+        val['passwordData']=Base64.decode64(
+            OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, val['passwordData'])
+        ).strip
+      end
+    end
+    val
+  end
+
+  # 启动虚拟机
+  # - @param [String] iid 虚拟机ID
+  def start_instance(iid)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    self.request('StartInstance', *kwargs)
+  end
+
+  # 停止虚拟机
+  # - @param [String] iid 虚拟机ID
+  # - @param [] force 是否强制停止虚拟机
+  def stop_instance(iid, force=false)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    kwargs['Force'] = force if force
+    self.request('StopInstance', *kwargs)
+  end
+
+  # 重启虚拟机
+  # - @param [String] iid 虚拟机ID
+  def reboot_instance(iid)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    self.request('RebootInstance', *kwargs)
+  end
+
+  # 删除虚拟机
+  # - @param [String] iid 虚拟机ID
+  def terminate_instance(iid)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    self.request('TerminateInstance', *kwargs)
+  end
+
+  # 重置虚拟机系统磁盘
+  # - @param [String] iid 虚拟机ID
+  # - @param [String] image_id 将虚拟机系统磁盘用指定镜像模板重置，如果无该参数，则使用原镜像模板重置
+  def rebuild_instance_root_image(iid, image_id=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    kwargs['ImageId'] = image_id if !(image_id.nil?) && image_id.size > 0
+    self.request('RebuildInstanceRootImage', *kwargs)
+  end
+
+  # 更改虚拟机类型
+  # - @param [String] iid 虚拟机ID
+  # - @param [String] itype  指定更改的虚拟机类型
+  # - @param [String] duration 指定更改后的初始租期，缺省为'1M'，即一个月
+  # - @param [Integer] datadisk 指定创建虚拟机使用的额外数据盘，单位为1GB
+  # - @param [Integer] bandwidth 指定创建虚拟机使用的额外带宽，单位为Mbps
+  # - 省略datadisk和bandwidth参数无法成功修改，具体用法可参考对应测试样例
+  def change_instance_type(iid, itype, duration=nil, datadisk=nil, bandwidth=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    kwargs['InstanceType'] = itype
+    unless duration.nil?
+      /^\d+[HhMm]$/.match(duration) ? kwargs['Duration'] = duration : (raise Exception('Illegal duration format'))
+    end
+
+    kwargs['ExtraExtDisksize'] = datadisk unless datadisk.nil?
+    kwargs['ExtraExtBandwidth'] = bandwidth unless bandwidth.nil?
+
+    self.request('ChangeInstanceType', *kwargs)
+  end
+
+  # 获取虚拟机的metadata
+  # - @param [String] iid 虚拟机ID
+  # - @return [Hash]  一个hash,包含虚拟机所有metadata的key/value
+  def get_instance_metadata(iid)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    val = self.request('GetInstanceMetadata', *kwargs)
+    val['InstanceMetadata']
+  end
+
+  # 修改虚拟机的metadata
+  # - @param [String] iid 虚拟机ID
+  # - @param [Hash] data  需要增加或修改的metadata信息
+  def put_instance_metadata(iid, data)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    names = []
+    values = []
+    data.each do |key, value|
+      names.push(key)
+      values.push(value)
+    end
+    kwargs['Name'] = names
+    kwargs['Value'] = values
+    self.request('PutInstanceMetadata', *kwargs)
+  end
+
+  # 获取用户的SSH密钥对
+  # - @param [Integer] limit 最大返回数量，用于分页控制
+  # - @param [Integer] offset 返回偏移量，用于分页控制
+  # - @param [Hash] filters 过滤条件，key/value分别指定过滤字段名称和值，支持的字段名称为：name
+  # - @return [Hash]  包含SSH密钥对列表
+  def describe_key_pairs(limit=0, offset=0, filters=nil)
+    kwargs = {}
+    self.parse_array_params(limit, offset, filters, kwargs)
+    val = self.request('DescribeKeyPairs', *kwargs)
+    val['KeyPairSet']
+  end
+
+  # 导入一个用户的SSH公钥，并创建一个SSH密钥对
+  # - @param [String] name 密钥对名称
+  # - @param [String] pubkey SSH公钥信息
+  # - @return [Hash] 创建的SSH密钥对信息
+  def import_key_pair(name, pubkey)
+    kwargs = {}
+    kwargs['KeyName'] = name
+    kwargs['PublicKeyMaterial'] = pubkey
+    val = self.request('ImportKeyPair', *kwargs)
+    val['KeyPair']
+  end
+
+  # 删除一个SSH密钥对
+  # - @param [String] kid 密钥对ID
+  def delete_key_pair(kid)
+    kwargs = {}
+    kwargs['KeyName'] = kid
+    self.request('DeleteKeyPair', *kwargs)
+  end
+
+  # 保存虚拟机的模板
+  # - @param [String] iid 虚拟机ID
+  # - @param [String] name 模板名称
+  # - @param [String] notes 保存模板的说明
+  # - @return [Hash] 请求是否成功
+  def create_template(iid, name, notes=nil)
+    kwargs = {}
+    kwargs['InstanceId'] = iid
+    kwargs['Name'] = name
+    kwargs['Notes'] = notes unless notes.nil?
+    self.request('CreateTemplate', *kwargs)
+  end
+
+  # 删除一个模板
+  # - @param [String] tid 模板ID
+  def delete_template(tid)
+    kwargs = {}
+    kwargs['TemplateId'] = tid
+    self.request('DeleteTemplate', *kwargs)
+  end
+end

data/lib/mos_sdk/base.rb

@@ -0,0 +1,169 @@
+require "uri"
+require "base64"
+require "openssl"
+require "net/http"
+require "json"
+require "logger"
+require "rubygems"
+require "crack"
+require "erb"
+include ERB::Util
+module MosSdk
+  class Base
+  end
+end
+
+class MosSdk::Base
+  attr_accessor :access, :secret, :url, :format, :timeout, :debug
+
+  # 基类初始化函数
+  # - @param [String] access
+  # - @param [String] secret
+  # - @param [String] url
+  # - @param [String] format  默认为xml格式
+  # - @param [Integer] timeout
+  # - @param [] debug
+  def initialize(access, secret, url, format='xml', timeout=300, debug=false)
+    @access=access
+    @secret=secret
+    @url=url
+    @format=format
+    @timeout=timeout
+    @debug=debug
+  end
+
+  def raw_request(action, *kwargs)
+    self._request(action, *kwargs)
+  end
+
+  # 处理请求函数
+  # - @param [String] action  函数名
+  # - @param [Hash] kwargs  函数调用参数
+  # - @return [HTTPResponse] 返回请求处理结果
+  def _request(action, *kwargs)
+    params = {}
+    params['Action'] = action
+    params['AWSAccessKeyId'] = self.access
+    params['Timestamp'] = Time.now.strftime("%Y-%m-%dT%H:%M:%S.000Z")
+    params['SignatureVersion'] = '2'
+    params['SignatureMethod'] = 'HmacSHA256'
+
+    unless kwargs.empty?
+      kwargs.each do |k, v|
+        if v.kind_of?(Array)
+          i = 1
+          v.each do |vi|
+            params['%s.%d' % [k, i]] = vi
+            i += 1
+          end
+        else
+          params[k] = v
+        end
+      end
+    end
+
+    params['Format'] = self.format if self.format
+    sig = self.get_signature(params)
+    params['Signature'] = sig
+    headers = {}
+    headers['User-Agent'] = 'ruby-mosclient'
+    data = URI.encode_www_form(params)
+    puts self.url + '?' + data if self.debug
+
+    uri = URI.parse(self.url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl=true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http.request_post('/', data, headers)
+  end
+
+  # 签名函数
+  # - @param [Hash] params  签名参数
+  # - @return [String]  签名处理结果
+  def get_signature(params) #signature method
+    req = URI.parse(self.url)
+    host = req.host
+    endpoint = host + ':' + req.port.to_s
+    path = req.path
+    path = '/' if req.path == ''
+    cred_dict = {'access' => self.access,
+                 'host' => endpoint,
+                 'verb' => 'POST',
+                 'path' => path,
+                 'params' => params,
+    }
+    params=Hash[params.sort]
+    sha256_hmac(string_to_sign(cred_dict, params))
+  end
+
+  # 字符串格式化函数
+  # - @param [Hash] cred_dict 认证信息
+  # - @param [Hash] params 认证参数
+  # - @return [String]  格式化结果
+  def string_to_sign(cred_dict, params)
+    [
+        cred_dict['verb'],
+        cred_dict['host'],
+        cred_dict['path'],
+        URI.encode_www_form(params),
+    ].join("\n")
+  end
+
+  # sha256算法实现
+  # - @param [String] value 加密内容
+  # - @return [String]  加密结果
+  def sha256_hmac(value)
+    Base64.encode64(
+        OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), self.secret, value)
+    ).strip
+  end
+
+  # 请求/响应函数，核心处理由_request函数实现
+  # - @param [String] action  函数名
+  # - @param [Hash] kwargs  函数调用参数
+  # - @return [Hash]  返回函数调用结果
+  def request(action, *kwargs)
+    resp = self._request(action, *kwargs)
+    body = resp.body
+    if self.debug
+      puts body
+    end
+
+    # todo begin 中if...else  执行else
+    begin
+      if resp.header['Content-Type'].start_with?('application/json')
+        body = JSON.parse(body)
+      else
+        body = Crack::XML.parse(body)
+        body["#{action}Response"]
+      end
+    rescue
+      return body
+    end
+  end
+
+  # 结果格式化函数
+  # - @param [Integer] limit  最大返回数量，用于分页控制
+  # - @param [Integer] offset  返回偏移量，用于分页控制
+  # - @param [Hash] filters  过滤条件，key/value分别指定过滤字段名称和值
+  # - @param [Hash] kwargs  其他参数
+  def parse_array_params(limit, offset, filters, kwargs)
+    kwargs['Limit'] = limit if limit > 0
+    kwargs['Offset'] = offset if offset > 0
+    unless filters.nil?
+      fidx = 1
+      filters.each do |k, vs|
+        kwargs['Filter.%d.Name' % fidx] = k
+        vs = [vs] unless vs.kind_of?(Array)
+        vidx = 1
+        vs.each do |v|
+          kwargs['Filter.%d.Value.%d' % [fidx, vidx]] = v
+          vidx += 1
+        end
+        fidx += 1
+      end
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: mos_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- yangcs2009
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Ruby SDK for MOS.
+email:
+- yangchangsheng@meituan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mos_sdk.rb
+- lib/mos_sdk/base.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for MOS.
+test_files: []