欢迎使用腾讯云开发者工具套件(SDK),本 SDK 是云 API 3.0 平台的配套工具。
- 依赖环境:Ruby 2.3 及以上版本。
- 从 腾讯云控制台 开通相应产品。
- 获取 SecretId、SecretKey 以及调用地址(endpoint),endpoint 一般形式为*.tencentcloudapi.com,如 CVM 的调用地址为 cvm.tencentcloudapi.com,具体参考各产品说明。
安装 Ruby SDK 前,先获取安全凭证。在第一次使用云 API 之前,用户首先需要在腾讯云控制台上申请安全凭证,安全凭证包括 SecretId 和 SecretKey, SecretId 是用于标识 API 调用者的身份,SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管,避免泄露。
以安装 cvm sdk 为例
前往 Github 仓库 或者 Gitee 仓库 下载最新代码,解压后
$ cd tencentcloud-sdk-ruby
$ cd tencentcloud-sdk-common
$ gem build tencentcloud-sdk-common.gemspec
$ gem install tencentcloud-sdk-common-3.0.427.gem
$ cd ../tencentcloud-sdk-cvm
$ gem build tencentcloud-sdk-cvm.gemspec
$ gem install tencentcloud-sdk-cvm-3.0.427.gem
注意:上述版本号请以实际为准,建议使用最新版。
# 安装最新版
git '[email protected]:TencentCloud/tencentcloud-sdk-ruby.git' do
gem 'tencentcloud-sdk-common'
gem 'tencentcloud-sdk-cvm'
end
# 国内用户加速
git '[email protected]:tencentcloud/tencentcloud-sdk-ruby.git' do
gem 'tencentcloud-sdk-common'
gem 'tencentcloud-sdk-cvm'
end
# 安装指定版本
git '[email protected]:tencentcloud/tencentcloud-sdk-ruby.git', tag: '3.0.428' do
gem 'tencentcloud-sdk-common'
gem 'tencentcloud-sdk-cvm'
end
# 安装全部
git '[email protected]:tencentcloud/tencentcloud-sdk-ruby.git' do
gem 'tencentcloud-sdk-common'
gem 'tencentcloud-sdk'
end
以查询实例列表接口为例。
# -*- coding: UTF-8 -*-
require 'tencentcloud-sdk-common'
require 'tencentcloud-sdk-cvm'
include TencentCloud::Common
include TencentCloud::Cvm::V20170312
begin
cre = Credential.new('SecretId', 'SecretKey')
cli = Client.new(cre, 'ap-guangzhou')
req = DescribeInstancesRequest.new(nil, nil, 0, 1)
cli.DescribeInstances(req)
rescue TencentCloudSDKException => e
puts e.message
puts e.backtrace.inspect
end
# -*- coding: UTF-8 -*-
require 'tencentcloud-sdk-common'
require 'tencentcloud-sdk-cvm'
begin
include TencentCloud::Common
# 导入对应产品模块的 client module
include TencentCloud::Cvm::V20170312
# 实例化一个认证对象,入参需要传入腾讯云账户 secretId,secretKey,此处还需注意密钥对的保密
cred = Credential.new('SecretId', 'SecretKey')
# 实例化一个 http 选项
httpProfile = HttpProfile.new()
# 如果需要指定 proxy 访问接口,可以按照如下方式初始化 hp
# httpProfile = HttpProfile.new(proxy='http://用户名:密码@代理 IP:代理端口')
httpProfile.scheme = "https" # 在外网互通的网络环境下支持 http 协议 (默认是 https 协议),建议使用 https 协议
httpProfile.req_method = "GET" # get 请求 (默认为 post 请求)
httpProfile.req_timeout = 30 # 请求超时时间,单位为秒 (默认 60 秒)
httpProfile.endpoint = "cvm.tencentcloudapi.com" # 指定接入地域域名 (默认就近接入)
# 实例化一个 client 选项,可选的,没有特殊需求可以跳过。
clientProfile = ClientProfile.new()
clientProfile.sign_method = "TC3-HMAC-SHA256" # 指定签名算法
clientProfile.language = "en-US" # 指定展示英文(默认为中文)
clientProfile.http_profile = httpProfile
clientProfile.debug = true # 打印 debug 日志
# 实例化要请求产品 (以 cvm 为例) 的 client 对象,clientProfile 是可选的。
client = Client.new(cred, "ap-shanghai", clientProfile)
# 实例化一个 cvm 实例信息查询请求对象,每个接口都会对应一个 request 对象。
req = DescribeInstancesRequest.new()
# 填充请求参数,这里 request 对象的成员变量即对应接口的入参。
# 你可以通过官网接口文档或跳转到 request 对象的定义处查看请求参数的定义。
respFilter = Filter.new() # 创建 Filter 对象,以 zone 的维度来查询 cvm 实例。
respFilter.Name = "zone"
respFilter.Values = ["ap-shanghai-1", "ap-shanghai-2"]
req.Filters = [respFilter] # Filters 是成员为 Filter 对象的列表
# 通过 client 对象调用 DescribeInstances 方法发起请求。注意请求方法名与请求对象是对应的。
# 返回的 resp 是一个 DescribeInstancesResponse 类的实例,与请求对象对应。
resp = client.DescribeInstances(req)
# 输出 json 格式的字符串回包
puts resp.serialize
# 也可以取出单个值。
# 你可以通过官网接口文档或跳转到 response 对象的定义处查看返回字段的定义。
puts resp.TotalCount
rescue TencentCloudSDKException => e
puts e.message
puts e.backtrace.inspect
end
如果是有代理的环境下,可通过两种方式设置代理
- 在初始化 HttpProfile 时指定 proxy
- 需要设置系统环境变量
https_proxy
否则可能无法正常调用,抛出连接超时的异常。