如何使用腾讯云MySQL API 3.0

一、背景

现网已经推出API 3.0，大量客户也在使用MySQL 3.0 API，由于老版本MySQL API和新版本MySQL 3.0 API存在部分差异，导致客户在使用过程中遇到一些困扰，为了更好的服务客户，针对MySQL 3.0 API做一个文档输出，方便一线同事和架构师回复用户咨询调用MySQL 3.0 API问题。

 

二、如何使用数据库MySQL API 3.0：

1、下载SDK，配置环境，安装相关包：

https://cloud.tencent.com/document/sdk/Python

依赖环境
（1）.依赖环境：Python 2.7 到 3.6 版本。
（2）.从 腾讯云控制台 开通相应产品。
（3）.获取 SecretID、SecretKey 以及调用地址。

 

2、在云API密钥上申请的标识身份的 SecretId，一个 SecretId 对应唯一的 SecretKey，具体可参考 签名方法 页面。

https://cloud.tencent.com/document/product/236/1738

 

3、MySQL API 3.0 概览

https://cloud.tencent.com/document/api/236/15830

 

4、测试用例：（工具：visual studio）

 

# -*- coding: utf-8 -*-

#!/usr/bin/python

# -*- coding: utf-8 -*-

# 引入云API入口模块

from tencentcloud.common import credential

from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException

from tencentcloud.cdb.v20170320 import cdb_client, models

try:

# 实例化一个认证对象，入参需要传入腾讯云账户secretId，secretKey

cred = credential.Credential("xxxx", "xxxx")

#实例化要请求产品(以cdb为例)的client对象。region：ap-shanghai

client = cdb_client.CdbClient(cred, "ap-shanghai")

#实例化一个请求对象:req = models.ModifyInstanceParamRequest()

req = models.CreateBackupRequest()

req.InstanceId = "cdb-7ghaiocc"

req.BackupMethod = "logical"

print req

# 通过client对象调用想要访问的接口，需要传入请求对象

resp = client.CreateBackup(req)

# 输出json格式的字符串回包

print(resp.to_json_string())

except TencentCloudSDKException as err:

print(err)

 

运行脚本

 

控制台返回结果：

 

（1）. 接口描述

接口请求域名： cdb.tencentcloudapi.com

本接口(CreateBackup)用于创建数据库备份。

（2）. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	是否必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBackup
Version	是	String	公共参数，本接口取值：2017-03-20
InstanceId	是	String	实例ID，格式如：cdb-xxxx。与云数据库控制台页面中显示的实例ID相同。
BackupMethod	是	String	目标备份方法，可选的值：logical - 逻辑冷备，physical - 物理冷备。

（3）. 输出参数

参数名称	类型	描述
BackupId	Integer	备份任务ID。
RequestId	String	唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的RequestId。

（4）. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.DatabaseAccessError	数据库内部错误。
InternalError.DesError	系统内部错误。
InvalidParameter	参数错误。
InvalidParameter.InstanceNotFound	实例不存在。

（5）. 示例

创建数据库备份

请求参数
https://cdb.tencentcloudapi.com/?Action=CreateBackup
&InstanceId=cdb-7ghaiocc
&BackupMethod=logical
&<公共请求参数>

返回参数
{"InstanceId": "cdb-7ghaiocc", "BackupMethod": "logical"}
{"RequestId": "923a8b41-388e-4372-954c-c8eeedd121bb"}

（6）. 查询请求参数结构体

结束语：本次分享到此，希望对大家有帮助。感谢大家的浏览。