实例相关接口API文档

Size: px

Start display at page:

Download "实例相关接口API文档"

晶医魏
5 years ago
Views:

1 云数据库 MySQL 实例相关接口 API 文档

2 版权声明腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品服务的当时的整体概况, 部分产品服务的内容可能有所调整您所购买的腾讯云产品服务的种类服务标准等应由您与腾讯云之间的商业合同约定, 除非双方另有约定, 否则, 腾讯云对本文档内容不做任何明示或模式的承诺或保证第 2 页共 60 页

3 文档目录文档声明... 2 创建实例 ( 包年包月 )... 4 创建实例 ( 按量计费 )... 7 查询可创建规格查询价格 ( 包年包月 ) 查询价格 ( 按量计费 ) 查询实例列表初始化实例查询初始化异步任务详情修改名称重置密码续费实例设置自动续费修改字符集查询回档任务详情查询回档任务列表查询私有网络子网实例数量第 3 页共 60 页

4 创建实例 ( 包年包月 ) 1. 接口描述本接口 (CreateCdb) 用于创建云数据库 MySQL 实例接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 CreateCdb 参数名称必选类型描述 engineversion 是 String MySQL 版本, 支持 5.5 和 5. 6, 请使用查询可创建规格接口获取实例版本 cdbtype 是 Int 实例类型, 请使用查询可创建规格接口获取实例类型 period 是 Int 实例时长, 单位 : 月, 最小查询可创建规格接口获取可创建的实例时长, 该接口返回字段 timespa n 表示时长可选值 goodsnum 是 Int 实例数量, 默认为 1, 最小值 1, 最大值为 10, 请使用查询可创建规格接口获取可创建的实例数量第 4 页共 60 页

5 参数名称必选类型描述 vpcid 否 String 私有网络 ID 值, 如果不传则查询私有网络列表 subnetid 否 String 私有网络下的子网 ID, 如果设置了 vpcid, 则此参数必须设置, 请使用查询子网列表 projectid 否 Int 项目 ID, 不填为默认项目请使用 DescribeProject 接口获取项目 ID 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 dealids Array 订单号 4. 示例输入 &< 公共请求参数 > &engineversion=5.5 &cdbtype=44 &vpcid=gz_vpc_13 &subnetid=gz_subnet_1115 &period=1 第 5 页共 60 页

6 输出 { "code": 0, "message": "", "dealids": [ "447275" ] 第 6 页共 60 页

7 创建实例 ( 按量计费 ) 1. 接口描述本接口 (CreateCdbHour) 用于创建实例 ( 按量计费 ) 接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 CreateCdbHour 参数名称是否必选类型描述 engineversion 是 String MySQL 版本, 支持 5.5 和 5. 6, 请使用查询可创建规格接口获取实例版本 cdbtype 是 Int 实例类型, 请使用查询可创建规格接口获取实例类型 goodsnum 是 Int 实例数量, 默认为 1, 最小值 1, 最大值为 10, 请使用查询可创建规格接口获取可创建的实例数量 vpcid 否 String 私有网络 ID 值, 如果不传则查询私有网络列表 subnetid 否 String 私有网络下的子网 ID, 如果设置了 vpcid, 则此参数必第 7 页共 60 页

8 参数名称是否必选类型描述须设置, 请使用查询子网列表 projectid 否 Int 项目 ID, 不填为默认项目请使用 DescribeProject 接口获取项目 ID 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 dealids Array 订单号 4. 示例输入 &< 公共请求参数 > &engineversion=5.6 &cdbtype=19 &goodsnum=1 输出 { "code": "0", "message": "", "dealids": [ " " 第 8 页共 60 页

9 ] 第 9 页共 60 页

10 查询可创建规格 1. 接口描述本接口 (DescribeCdbProductList) 用于查询云数据库 MySQL 可创建的规格接口请求域名 :cdb.api.qcloud.com 2. 输入参数此接口没有请求参数, 正式调用时只需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DescribeCdbProductList 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 configs Object 实例配置信息其中,configs 参数构成如下 : 参数名称类型描述 code Int 错误码, 0: 成功, 其他值 : 失败 message String 错误信息 timespan Array 当前用户地域下可购买的时间, 单位月 mingoodsnumperdeal Int 单个订单允许购买最小数 maxgoodsnumperdeal Int 单个订单允许购买最大数 goodsdescription Object 实例信息其中 goodsdescription 表示实例信息, 其构成如下 : 第 10 页共 60 页

11 参数名称类型描述 basenet Object 基础网络, 可创建的网络类型 VPCNet Object VPC 网络, 可创建的网络类型其中 basenet 表示基础网络, 其构成如下 : 参数名称类型描述 MySQL5.5 Object 可创建实例的 MySQL 版本, 可能的值有 MySQL5.5 MySQL5.6 MySQL5.6 Object 可创建的实例 MySQL 版本, 可能的值有 MySQL5.5 MySQL5.6 其中 MySQL5.5 表示可创建的数据库版本号, 其构成如下 : 参数名称类型描述 52 Object 云数据库实例类型, 每一种数据库实例类型用一个数字表示, 且其包含该类型的配置信息 52.cdbType Int 云数据库实例类型, 可用于查询价格和创建实例 52.typeName String 实例类型中文名称 52.subTypeName String 实例类型扩展名称 52.volume Int 实例容量, 单位 GB 52.visits Int 每秒访问次数 52.binlogSize Int binlog 大小, 单位 GB 52.suitinfo String 实例推荐使用场景 52.typeOrder Int 排序用字段 52.subTypeOrder Int 排序用字段 52.memory Int 内存大小其中 VPCNet 表示 VPC 网络, 其构成如下 : 参数名称类型描述 MySQL5.5 Object 可创建的实例 MySQL 版本, 可能的第 11 页共 60 页

12 参数名称类型描述值有 MySQL5.5 MySQL5.6 MySQL5.6 Object 可创建的实例 MySQL 版本, 可能的值有 MySQL5.5 MySQL5.6 其中 MySQL5.5 表示可创建的数据库版本号, 其构成如下 : 参数名称类型描述 52 Object 云数据库实例类型, 每一种数据库实例类型用一个数字表示, 且其包含该类型的配置信息 52.cdbType Int 云数据库实例类型, 可用于查询价格和创建实例 52.typeName String 实例类型中文名称 52.subTypeName String 实例类型扩展名称 52.volume Int 实例容量, 单位 GB 52.visits Int 每秒访问次数 52.binlogSize Int binlog 大小, 单位 GB 52.suitinfo String 实例推荐使用场景 52.typeOrder Int 排序用字段 52.subTypeOrder Int 排序用字段 52.memory Int 内存大小 4. 示例输入 &< 公共请求参数 > 输出 { 第 12 页共 60 页

13 "code": 0, "message": "", "configs": { "timespan": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 ], "mingoodsnumperdeal": 1, "maxgoodsnumperdeal": 10, "goodsdescription": { "basenet": { "MySQL5.5": { "19": { "cdbtype": 19, "subtypename": " 超微型 ", "volume": 10, "visits": 120, "binlogsize": 1, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万的工具类应用 ", "subtypeorder": 0, "memory": 360, 第 13 页共 60 页

14 "20": { "cdbtype": 20, "subtypename": " 微型 ", "volume": 25, "visits": 1000, "binlogsize": 3, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 1, "memory": 1000, "21": { "cdbtype": 21, "subtypename": " 小型 ", "volume": 50, "visits": 2400, "binlogsize": 7, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 2, "memory": 2000, "22": { "cdbtype": 22, "subtypename": "C 型 ", "volume": 100, "visits": 4400, "binlogsize": 15, "suitinfo": " 日活跃用户数上十万人级别的中型游戏应用 ", "subtypeorder": 3, 第 14 页共 60 页

15 "memory": 4000, "23": { "cdbtype": 23, "subtypename": " 中型 ", "volume": 250, "visits": 15000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 5, "memory": 12000, "24": { "cdbtype": 24, "subtypename": " 大型 ", "volume": 500, "visits": 23000, "binlogsize": 100, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 7, "memory": 24000, "25": { "cdbtype": 25, "subtypename": " 超大型 ", "volume": 1000, "visits": 37000, "binlogsize": 200, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", 第 15 页共 60 页

16 "subtypeorder": 8, "memory": 48000, "26": { "cdbtype": 26, "subtypename": "A 型 ", "volume": 400, "visits": 18000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 6, "memory": 16000, "27": { "cdbtype": 27, "subtypename": "B 型 ", "volume": 200, "visits": 7200, "binlogsize": 30, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 4, "memory": 8000, "MySQL5.6": { "19": { "cdbtype": 19, "subtypename": " 超微型 ", 第 16 页共 60 页

17 "volume": 10, "visits": 120, "binlogsize": 1, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万的工具类应用 ", "subtypeorder": 0, "memory": 360, "20": { "cdbtype": 20, "subtypename": " 微型 ", "volume": 25, "visits": 1000, "binlogsize": 3, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 1, "memory": 1000, "21": { "cdbtype": 21, "subtypename": " 小型 ", "volume": 50, "visits": 2400, "binlogsize": 7, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 2, "memory": 2000, "22": { "cdbtype": 22, 第 17 页共 60 页

18 "subtypename": "C 型 ", "volume": 100, "visits": 4400, "binlogsize": 15, "suitinfo": " 日活跃用户数上十万人级别的中型游戏应用 ", "subtypeorder": 3, "memory": 4000, "23": { "cdbtype": 23, "subtypename": " 中型 ", "volume": 250, "visits": 15000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 5, "memory": 12000, "24": { "cdbtype": 24, "subtypename": " 大型 ", "volume": 500, "visits": 23000, "binlogsize": 100, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 7, "memory": 24000, 第 18 页共 60 页

19 "25": { "cdbtype": 25, "subtypename": " 超大型 ", "volume": 1000, "visits": 37000, "binlogsize": 200, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 8, "memory": 48000, "26": { "cdbtype": 26, "subtypename": "A 型 ", "volume": 400, "visits": 18000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 6, "memory": 16000, "27": { "cdbtype": 27, "subtypename": "B 型 ", "volume": 200, "visits": 7200, "binlogsize": 30, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 4, 第 19 页共 60 页

20 "memory": 8000, "VPCNet": { "MySQL5.5": { "19": { "cdbtype": 19, "subtypename": " 超微型 ", "volume": 10, "visits": 120, "binlogsize": 1, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万的工具类应用 ", "subtypeorder": 0, "memory": 360, "20": { "cdbtype": 20, "subtypename": " 微型 ", "volume": 25, "visits": 1000, "binlogsize": 3, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 1, "memory": 1000, "21": { "cdbtype": 21, "subtypename": " 小型 ", 第 20 页共 60 页

21 "volume": 50, "visits": 2400, "binlogsize": 7, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 2, "memory": 2000, "22": { "cdbtype": 22, "subtypename": "C 型 ", "volume": 100, "visits": 4400, "binlogsize": 15, "suitinfo": " 日活跃用户数上十万人级别的中型游戏应用 ", "subtypeorder": 3, "memory": 4000, "23": { "cdbtype": 23, "subtypename": " 中型 ", "volume": 250, "visits": 15000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 5, "memory": 12000, "24": { "cdbtype": 24, 第 21 页共 60 页

22 "subtypename": " 大型 ", "volume": 500, "visits": 23000, "binlogsize": 100, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 7, "memory": 24000, "25": { "cdbtype": 25, "subtypename": " 超大型 ", "volume": 1000, "visits": 37000, "binlogsize": 200, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 8, "memory": 48000, "26": { "cdbtype": 26, "subtypename": "A 型 ", "volume": 400, "visits": 18000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 6, "memory": 16000, 第 22 页共 60 页

23 "27": { "cdbtype": 27, "subtypename": "B 型 ", "volume": 200, "visits": 7200, "binlogsize": 30, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 4, "memory": 8000, "MySQL5.6": { "19": { "cdbtype": 19, "subtypename": " 超微型 ", "volume": 10, "visits": 120, "binlogsize": 1, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万的工具类应用 ", "subtypeorder": 0, "memory": 360, "20": { "cdbtype": 20, "subtypename": " 微型 ", "volume": 25, "visits": 1000, "binlogsize": 3, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", 第 23 页共 60 页

24 "subtypeorder": 1, "memory": 1000, "21": { "cdbtype": 21, "subtypename": " 小型 ", "volume": 50, "visits": 2400, "binlogsize": 7, "suitinfo": " 日活跃用户数上万的小型游戏应用或百万人级别的工具类应用 ", "subtypeorder": 2, "memory": 2000, "22": { "cdbtype": 22, "subtypename": "C 型 ", "volume": 100, "visits": 4400, "binlogsize": 15, "suitinfo": " 日活跃用户数上十万人级别的中型游戏应用 ", "subtypeorder": 3, "memory": 4000, "23": { "cdbtype": 23, "subtypename": " 中型 ", "volume": 250, "visits": 15000, 第 24 页共 60 页

25 "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 5, "memory": 12000, "24": { "cdbtype": 24, "subtypename": " 大型 ", "volume": 500, "visits": 23000, "binlogsize": 100, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 7, "memory": 24000, "25": { "cdbtype": 25, "subtypename": " 超大型 ", "volume": 1000, "visits": 37000, "binlogsize": 200, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 8, "memory": 48000, "26": { "cdbtype": 26, "subtypename": "A 型 ", 第 25 页共 60 页

26 "volume": 400, "visits": 18000, "binlogsize": 65, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 6, "memory": 16000, "27": { "cdbtype": 27, "subtypename": "B 型 ", "volume": 200, "visits": 7200, "binlogsize": 30, "suitinfo": " 日活跃用户数在百万人级别的大型游戏应用 ", "subtypeorder": 4, "memory": 8000 第 26 页共 60 页

27 查询价格 ( 包年包月 ) 1. 接口描述本接口 (InquiryCdbPrice) 用于查询某个云数据库实例类型的价格接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 InquiryCdbPrice 参数名称必选类型描述 cdbtype 是 Int 实例类型, 请使用查询可创建规格接口获取实例类型 period 是 Int 实例时长, 单位 : 月, 最小查询可创建规格接口获取可创建的实例时长, 该接口返回字段 timespa n 表示时长可选值 goodsnum 是 Int 实例数量, 默认为 1, 最小值 1, 最大值为 10, 请使用查询可创建规格接口获取可创建的实例数量 3. 输出参数第 27 页共 60 页

28 参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 originalprice Int 原价, 单位 : 分 ( 人民币 ) price Int 实际价格, 单位 : 分 ( 人民币 ) 4. 示例输入 &< 公共请求参数 > &cdbtype=44 &period=1 &goodsnum=1 输出 { "code": 0, "message": "", "originalprice": 2100, "price": 2100 第 28 页共 60 页

29 查询价格 ( 按量计费 ) 1. 接口描述本接口 (InquiryCdbPriceHour) 用于查询某个云数据库实例类型的按量计费价格 ( 单位 : 元 / 小时 ) 接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 InquiryCdbPriceHour 参数名称是否必选类型描述 cdbtype 是 Int 实例类型, 请使用查询可创建规格接口获取实例类型 goodsnum 是 Int 实例数量, 默认为 1, 最小值 1, 最大值为 10, 请使用查询可创建规格接口获取可创建的实例数量 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 originalprice Int 原价, 单位 : 分 ( 人民币 ) price Int 实际价格, 单位 : 分 ( 人民币 ) 第 29 页共 60 页

30 4. 示例输入 &< 公共请求参数 > &engineversion=5.6 &cdbtype=19 &goodsnum=1 &period=1 输出 { "code": "0", "message": "", "codedesc": "Success", "originalprice": 13, "price": 13 第 30 页共 60 页

31 查询实例列表 1. 接口描述本接口 (DescribeCdbInstances) 用于获取云数据库 MySQL 实例列表接口请求域名 :cdb.api.qcloud.com 1. 可根据项目 ID 云数据库实例 ID 或者访问地址作过滤条件来获取实例列表 2. 不指定任何过滤条件, 则返回当前用户的默认数量 (20) 的云数据库实例 3. 每次请求最多可返回 100 条实例记录 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DescribeCdbInstances 参数名称必选类型描述 projectid 否 Int 项目 ID, 请使用 DescribeProject 接口查询项目 ID cdbinstanceids.n 否 String 一个或者多个实例 ID,n 表示从 0 开始的数组下标请使用 DescribeCdbInstances 接口查询实例 ID cdbinstancevips.n 否 String 一个或者多个实例访问地址,n 表示从 0 开始的数组下标请使用 DescribeCdbInstances 接口查询实例访问地址 offset 否 Int 偏移量, 默认为 0 limit 否 Int 单次请求返回的数量, 默认为 20, 最大值为 100 第 31 页共 60 页

32 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 totalcount Int 符合查询条件的实例总数 cdbinstanceset Array 返回的实例信息其中,cdbInstanceSet 参数的构成如下 : 参数名称类型描述 cdbinstanceid String 实例 ID storagesize Int 存储容量, 单位 :G maxquerycount Int 最大查询次数, 单位 : 次 / 秒 cdbinstancename String 实例名称 cdbinstancevip String 访问 IP cdbinstancevport Int 访问端口 status Int 实例状态, 状态值 :0: 创建中,1: 运行中 engineversion String 数据库引擎版本 cdbinstancecreatetime String 创建时间, 格式如 :41:07 cdbinstancedeadlinetime String 实例购买截止时间, 格式如 :41:07 cdbtypeset Int 实例类型的序号, 可用此参数购买同类型实例或者查询同类型实例的续费价格 cdbtype String 实例类型描述 autorenew Int 自动续费标识,0 为不自动续费,1 为自动续费 vpcid Int 私有网络 ID subnetid Int 私有网络子网 ID 第 32 页共 60 页

33 参数名称类型描述 projectid Int 项目 ID 4. 示例输入 &< 公共请求参数 > &cdbinstanceids.0=qcdb1 &cdbinstanceids.1=qcdb2 输出 { 'code': 0, 'message': '', 'totalcount': 2, 'cdbinstanceset': [ { "cdbinstanceid": "qcdb1a", "storagesize": 10, "maxquerycount": 120, "cdbinstancename": "testname", "cdbinstancevip": "xx.xx.xx.xx", "cdbinstancevport": 3306, "status": 1, "engineversion": "5.6", "cdbinstancecreatetime": " :47:47", "cdbinstancedeadlinetime": " :28:31", "cdbtypeset": 44, "cdbtype": "HZ3_DBH128", "autorenew": 0, 第 33 页共 60 页

34 "vpcid": 0, "subnetid": 0, "projectid": 0, { "cdbinstanceid": "qcdb9", "storagesize": 100, "maxquerycount": 4400, "cdbinstancename": "testname", "cdbinstancevip": "xx.xx.xx.xx", "cdbinstancevport": 3306, "status": 1, "engineversion": "5.5", "cdbinstancecreatetime": " :55:37", "cdbinstancedeadlinetime": " :55:39", "cdbtypeset": 47, "cdbtype": "HZ3_DBH12", "autorenew": 0, "vpcid": 0, "subnetid": 0, "projectid": 0 ] 第 34 页共 60 页

35 初始化实例 1. 接口描述本接口 (CdbMysqlInit) 用于初始化实例接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 CdbMysqlInit 参数名称是否必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID charset 是 String 字符集, 支持 [ latin1 utf 8 gbk utf8mb4 ] port 是 Int 自定义端口 lowercasetablenames 是 Int 表名是否只存储为小写 1 : 表名存储为小写, 0: 表名大小写敏感 password 是 String 设置 root 密码, 规则 :8-1 6 个字符, 至少包含字母数字字符 (!@#$%^*() ) 中的两种 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见第 35 页共 60 页

36 参数名称类型描述错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 jobid Int 任务 ID 初始化实例是异步操作, 提交成功后返回一个任务 ID, 可以拿这个 ID 查询初始化异步任务详情 4. 示例输入 &< 公共请求参数 > &cdbinstanceid=qcdbxxxxxx &charset=utf8 &port=12345 &password=cloud &lowercasetablenames=0 输出 { "code":"0", "message":"", "codedesc":"success", "jobid":"11" 第 36 页共 60 页

37 查询初始化异步任务详情 1. 接口描述本接口 (GetCdbInitInfo) 用于查询初始化异步任务详情接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 GetCdbInitInfo 参数名称是否必选类型描述 jobid 是 Int 初始化任务 ID, 是执行初始化实例时的返回值 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 data Array 任务详情其中,data 参数的构成如下 : 参数名称类型描述 jobid String 任务 ID starttime String 任务开始时间 status String 任务状态,0 代表运行中,2 代表第 37 页共 60 页

38 参数名称类型描述执行成功,3 代表执行失败,4 代表已中止,5 代表已删除,6 代表正在中止 progress String 任务进度,0 代表任务开始,100 代表任务完成 endtime String 任务结束时间 errorcode String 任务错误码, 0 表示成功, 其他值表示失败 message String 任务信息, 如果任务失败, 则返回出错信息 4. 示例输入 &< 公共请求参数 > &jobid=9 输出 { "code":"0", "message":"", "data":{ "starttime":" :52:21", "jobid":"9", "status":"2", "progress":"100", "endtime":" :53:23", "errorcode":"0", "message":"success" 第 38 页共 60 页

39 第 39 页共 60 页

40 修改名称 1. 接口描述本接口 (ModifyCdbInstanceName) 用于修改云数据库实例名称接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 ModifyCdbInstanceName 参数名称必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID cdbinstancename 是 String 实例名称, 规则 :1-60 个字母数字非符号中文 _ - 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 data Object 数据其中,data 参数构成如下 : 参数名称类型描述 taskid Int 任务 Id 第 40 页共 60 页

41 4. 示例输入 &< 公共请求参数 > &cdbinstanceid=cdb-oy5wjit0 &cdbinstancename=newname 输出 { 'code': 0, 'message': '', 'data': { 'taskid': 第 41 页共 60 页

42 重置密码 1. 接口描述本接口 (ResetCdbInstancesPassword) 用于重置云数据库实例密码接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 ResetCdbInstancesPassword 参数名称必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID password 是 String 新的 root 密码, 规则 :8-1 6 个字符, 至少包含字母数字字符 (!@#$%^*() ) 中的两种 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 data Object 数据其中,data 参数构成如下 : 参数名称类型描述第 42 页共 60 页

43 参数名称类型描述 taskid Int 任务 Id 4. 示例输入 &< 公共请求参数 > &cdbinstanceid=qcdbxxxxxxxxxxx 输出 { "code": 0, "message": "", "data": { "taskid": 第 43 页共 60 页

44 续费实例 1. 接口描述本接口 (RenewCdb) 用于续费云数据库实例接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 RenewCdb 参数名称必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID 请选择包年包月实例进行操作, 按量计费实例不需要续费 period 是 Int 续费时长, 单位 : 月, 最小查询可创建规格接口获取可创建的实例时长, 该接口返回字段 timespa n 表示时长可选值 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码第 44 页共 60 页

45 参数名称类型描述 message String 错误信息 dealids Array 续费订单号 4. 示例输入 &< 公共请求参数 > &cdbinstanceid=qcdbxxxxxxxxxxx &period=1 输出 { "code": 0, "message": "", "dealids": [ "447276" ] 第 45 页共 60 页

46 设置自动续费 1. 接口描述本接口 (SetCdbAutoRenew) 用于设置或取消云数据库实例自动续费接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 SetCdbAutoRenew 参数名称必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID isautorenew 是 String 是否自动续费 :Y/N,Y 表示设置实例为自动续费,N 表示设置实例为不自动续费 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 data Array 数据 4. 示例输入第 46 页共 60 页

47 &< 公共请求参数 > &cdbinstanceid=qcdbxxxxxxxxxxx &isautorenew=y 输出 { "code":"0", "message":"", "data":[ ] 第 47 页共 60 页

48 修改字符集 1. 接口描述本接口 (ModifyCdbCharset) 用于修改云数据库实例字符集接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 ModifyCdbCharset 参数名称必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID charset 是 String 修改后的字符集, 目前支持的字符集 ("latin1","utf8","gbk","utf8mb4") 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 data Object 返回数据其中,data 参数构成如下 : 参数名称类型描述 taskid Int 任务 Id 第 48 页共 60 页

49 4. 示例输入 &< 公共请求参数 > &cdbinstanceid=qcdbxxxxxxx &charset=utf8 输出 { "code":"0", "message":"", "data":{ "taskid":" " 第 49 页共 60 页

50 查询回档任务详情 1. 接口描述本接口 (GetCdbRollbackJobTask) 用于查询云数据库实例回档任务详情接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 GetCdbRollbackJobTask 参数名称必选类型描述 jobid 是 Int 回档任务 ID, 请使用 GetCdbRollbackJob 接口查询任务 ID 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 data Array 返回的数据其中,data 参数构成如下 : 参数名称类型描述 jobinfo Object 任务信息 taskdetail Object 任务详情其中 jobinfo 表示任务信息, 其结构如下 : 第 50 页共 60 页

51 参数名称类型描述 code String 错误码,0: 成功, 其他值 : 失败 message String 错误信息 jobid Int 任务 ID type Int 任务类型 status Int 任务状态 progress Int 任务进度 starttime String 任务开始时间 endtime String 任务结束时间 detail Array 任务详情其中 detail 表示任务详情, 其结构如下 : 参数名称类型描述 instanceid String 实例 ID instancename String 实例名 strategy String 回档策略 rollbacktime String 回档时间 type String 类型 operator String 操作者 dbs Array 数据库信息 dbs.dbname String db 名称 dbs.newname String db 新名称其中 taskdetail 表示任务信息, 其结构如下 : 参数名称类型描述 code int 错误码,0: 成功, 其他值 : 失败 message String 错误信息 taskid String 任务 Id workid String 工作 Id status String 状态 progress String 进度 starttime String 开始时间第 51 页共 60 页

52 参数名称类型描述 endtime String 结束时间 taskinfo Array 任务信息其中 taskinfo 表示任务信息, 其结构如下 : 参数名称类型描述 instanceid String 实例 ID instancename String 实例名 strategy String 回档策略 rollbacktime String 回档时间 type String 鉴权方式 operator String 操作者 dbs Array 数据库 dbs.dbname String db 名称 dbs.newname String db 新名称 4. 示例输入 &< 公共请求参数 > &jobid=12782 输出 { "code":"0", "message":"", "data":{ "jobinfo":{ "jobid":"12782", 第 52 页共 60 页

53 "type":"10", "status":"2", "progress":"100", "code":"0", "message":" 所有实例回档成功 ", "starttime":" :58:29", "endtime":" :00:02", "detail":[ { "instanceid":" e-11ec-11e6-abea-0819a6d0fc09", "instancename":"cdb154047", "strategy":"full", "rollbacktime":" :57:56", "type":"nopriv", "operator":" ", "dbs":[ { "dbname":"test", "newname":"test_bak" ] ], "taskdetail":[ { "taskinfo":{ "instanceid":" e-11ec-11e6-abea-0819a6d0fc09", "instancename":"cdb154047", "strategy":"full", "rollbacktime":" :57:56", "type":"nopriv", "operator":" ", "dbs":[ 第 53 页共 60 页

54 { "dbname":"test", "newname":"test_bak" ], "taskid":"105", "workid":"311396", "status":"2", "progress":"100", "code":"0", "message":" 回档成功 ", "starttime":" :59:01", "endtime":" :00:02" ] 第 54 页共 60 页

55 查询回档任务列表 1. 接口描述本接口 (GetCdbRollbackJob) 用于获取云数据库实例回档任务列表接口请求域名 :cdb.api.qcloud.com 1. 根据云数据库实例 ID 获取云数据库实例回档任务列表 ; 2. 单次请求最多可返回 100 条任务记录 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 GetCdbRollbackJob 参数名称必选类型描述 cdbinstanceid 是 String 实例 ID, 请使用 DescribeCdbInstances 接口查询实例 ID offset 否 Int 偏移量, 默认为 0 limit 否 Int 返回任务数量, 默认为 50, 最大值为输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 错误信息 data Array 返回的回档任务集合其中,data 参数构成如下 : 第 55 页共 60 页

56 参数名称类型描述 taskcount Int 回档任务总数 tasklist Array 回档任务集合其中 tasklist 表示任务列表数据, 构成如下 : 参数名称类型描述 appid String appid endtime String 结束时间 errorcode String 错误码 jobid String 任务 ID, 在任务列表里可以查询到 message String 回档信息 name String 待回档库表 newname String 回档后库表 progress String 回档进度 starttime String 开始时间 status Int 回档状态 taskid String 回档 ID taskmessage String 任务执行结果 taskprogress String 任务执行进度 taskstatus String 任务执行状态 type String 任务类型 1: 数据库回档,10: 批量数据库回档 uin String 所属 UIN taskcontext Array 任务详情其中 taskcontext 表示任务的详细信息, 构成如下 : 参数名称类型描述 data Array 任务具体详情 data.operator String 操作者 uin data.rollbacktime String 回档时间点 data.strategy String 回档策略第 56 页共 60 页

57 参数名称类型描述 data.type String 回档类型 data.dbs Array 回档库详情 data.dbs.dbname String 待回档库名 data.dbs.newname String 回档后库名 4. 示例输入 &< 公共请求参数 > &cdbinstanceid=qcdbxxxxxxxxx 输出 { "code":"0", "message":"", "data":{ "taskcount":"1", "tasklist":[ { "appid":"123456", "endtime":" :35:02", "errorcode":"0", "jobid":"1343", "message":"0", "name":"test, test_bak", "newname":"test_bakee, test_bak_bak", "progress":"100", "starttime":" :32:59", "status":"2", 第 57 页共 60 页

58 "taskid":"429", "taskmessage":" 回档成功 ", "taskprogress":"100", "taskstatus":"2", "type":"10", "uin":"231323", "taskcontext":{ "data":{ "operator":"231323", "rollbacktime":" :32:39", "strategy":"full", "type":"nopriv", "dbs":[ { "dbname":"test", "newname":"test_bakee", { "dbname":"test_bak", "newname":"test_bak_bak" ] ] 第 58 页共 60 页

59 查询私有网络子网实例数量 1. 接口描述本接口 (GetCdbInstanceNumByVpcSubnetId) 用于查询私有网络子网下的实例数量接口请求域名 :cdb.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 GetCdbInstanceNumByVpcSubnetId 参数名称是否必选类型描述 vpcid 是 Int 私有网络 ID 值, 请使用查询私有网络列表 subnetids.n 否 String 私有网络下的子网 ID, 请使用查询子网列表 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 codedesc String 错误码描述 info Array 返回数据其中,info 参数的构成如下 : 参数名称类型描述 total int 私有网络子网下的实例数量第 59 页共 60 页

60 Powered by TCPDF ( 实例相关接口 API 文档参数名称类型描述 vpcid int 私有网络 ID subnetids Array 私有网络下的子网 ID 4. 示例输入 &< 公共请求参数 > &vpcid=13 &subnetids.1=1115 &subnetids.2=220 输出 { "code":"0", "message":"", "codedesc":"success", "data":{ "total":"2", "vpcid":"13", "subnetids":{ "220":"1", "1115":"1" 第 60 页共 60 页

实例相关接口API文档

实例相关接口API文档云数据库 MySQL 实例相关接口 API 文档版权声明 2015-2016 腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品