云API入门必读
为方便您快速轻松调用云 API 来管理您的云资源,云 API 提供了 API Explorer以及SDK工具。通过调用标准 API V3 接口,您只需少量代码即可快速操作云产品。
说明:
运营平台基础版不支持第三方产品的API文档管理。
API Explorer
提供了在线调用、签名验证、SDK代码生成和快速检索接口等能力,能显著降低使用云API 3.0的难度。
SDK
开发者工具套件(SDK)3.0是云 API 3.0平台的配套工具,云 API 3.0 产品提供 5 种语言 SDK,在每个语言SDK包的根路径下都有“examples”文件夹,存放接口调用示例,供用户参考。
一般来说,下列信息需要您根据实际情况自行修改:
- 导入对应产品模块对应Module包
- 获取SecretId & SecretKey
- Endpoint
- Region
- 接口入参信息
下面以Python语言实例租户端API接口调用为例:
操作步骤
在【云API管理】>【租户端】>【SDK下载】页面,下载Python语言的SDK包。
解压后获取“\examples\location\v20191128\describeRegionZoneTest.py”文件。
参考该文件,修改如下信息。
导入对应产品模块对应Module包。
# 导入对应产品模块的client models。 from tcecloud.location.v20191128 import location_client, models
其中,tcecloud是项目下的根目录,location是ServiceType名称,v20191128是模块的版本信息。
获取SecretId和SecretKey,修改“Credential”值。
try: request.protocol = 'http' # 使用https协议(默认使用http协议) # 实例化一个认证对象,入参需要传入账户secretId,secretKey cred = credential.Credential( "SECRET_ID", "SECRET_KEY")
其中,“SECRET_ID"和”SECRET_KEY“从【访问管理】>【云API密钥】中获取。
修改endpoint。
# 实例化一个http选项,可选的,没有特殊需求可以跳过。 httpProfile = HttpProfile() # httpProfile.reqMethod = "GET" # post请求(默认为post请求) # httpProfile.reqTimeout = 30 # 请求超时时间,单位为秒(默认60秒) httpProfile.endpoint = "location.api3.tcenter-dev.tcecqpoc.fsphere.cn" # location是接入的产品名,api3是调用版本, tcenter-dev.tcecqpoc.fsphere.cn是主域名。
endpoint拼接规则为{产品}.{租户端}.{域名}。
一般情况修改产品名称即可。如上示例中给出的是location产品运营端的endpoint。
获取Region。
# 实例化要请求产品(以location为例)的client对象,clientProfile是可选的。 client = location_client.LocationClient(cred, "", clientProfile)
其中,LocationClient中补充Region信息。
通过页面获取
以CVM获取为例,从页面location的DescribeRegionZone接口获取,如下图所示:
通过SDK获取
调用location的DescribeRegionZone接口获取。修改SDK包中“\examples\location\v20191128\describeRegionZoneTest.py”文件的SecretId和SecretKey修改后,直接进行调用。
接口入参。
API文档中心下载API文档,配合使用。