L67
中 华 人 民 共 和 国 国 家 标 准
GB/T32633—2016
分布式关系数据库服务接口规范
Distributedrelationaldatabaseserviceinterfacespecification
2016-04-25发布 2016-11-01实施
中华人民共和国国家质量监督检验检疫总局
中 国 国 家 标 准 化 管 理 委 员 会
发 布
满
智
科
技
满
智
科
技
目 次
前言 Ⅲ…………………………………………………………………………………………………………
1 范围 1………………………………………………………………………………………………………
2 规范性引用文件 1…………………………………………………………………………………………
3 术语和定义 1………………………………………………………………………………………………
4 缩略语 1……………………………………………………………………………………………………
5 接口调用方式 1……………………………………………………………………………………………
请求 1…………………………………………………………………………………………………
返回 1…………………………………………………………………………………………………
6 接口定义格式 1……………………………………………………………………………………………
7 数据库实例接口 2…………………………………………………………………………………………
概述 2…………………………………………………………………………………………………
创建数据库实例 2……………………………………………………………………………………
删除数据库实例 3……………………………………………………………………………………
修改数据库实例 4……………………………………………………………………………………
查看数据库实例 5……………………………………………………………………………………
重启数据库实例 5……………………………………………………………………………………
8 管理接口 6…………………………………………………………………………………………………
概述 6…………………………………………………………………………………………………
查看数据库引擎版本 6………………………………………………………………………………
查看数据库日志文件 7………………………………………………………………………………
下载查看数据库日志文件 8…………………………………………………………………………
9 共用参数 8…………………………………………………………………………………………………
10 共用错误信息 9……………………………………………………………………………………………
Ⅰ
GB/T32633—2016
满
智
科
技
满
智
科
技
前 言
本标准按照GB/—2009给出的规则起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。
本标准由全国信息技术标准化技术委员会(SAC/TC28)提出并归口。
本标准起草单位:中国电子技术标准化研究院、清华大学、武汉达梦数据库有限公司。
本标准主要起草人:李莹、叶晓俊、曹忠升、卫凤林、张展新。
Ⅲ
GB/T32633—2016
满
智
科
技
满
智
科
技
分布式关系数据库服务接口规范
1 范围
本标准规定了分布式计算环境中关系数据库服务应提供的接口,包括数据库实例接口和管理接口,
同时规定分布式关系数据库服务接口的调用方式、共用参数和共用错误信息。
本标准适用于运行在分布式计算环境中关系数据库服务的研制和测试。
2 规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅注日期的版本适用于本文
件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
IETFRFC2616 超文本传输协议 HTTP/(HypertextTransferProtocol———HTTP/)
3 术语和定义
下列术语和定义适用于本文件。
数据库实例 databaseinstance
一个独立占用物理内存的数据库服务进程。
4 缩略语
下列缩略语适用于本文件。
HTTP:超文本传输协议(hypertexttransferprotocol)
JSON:JavaScript对象标记(javascriptobjectnotation)
URL:统一资源定位符(uniformresourcelocators)
XML:可扩展置标语言(extensiblemarkuplanguage)
5 接口调用方式
请求
应通过IETFRFC2616中规定的HTTP请求格式调用分布式关系数据库服务产品接口,并将请
求参数包含在请求的URL中。
返回
调用成功后应以XML或JSON格式返回结果,调用失败时返回相应的错误信息。
6 接口定义格式
分布式关系数据库服务产品的数据库实例接口和管理接口定义格式如下:
1
GB/T32633—2016
满
智
科
技
a) 接口名:接口的名称;
b) 描述:对接口内容的简单描述;
c) 参数:请求调用的参数;
d) 返回值:请求返回的内容;
e) 错误信息:调用错误时返回的信息。
7 数据库实例接口
概述
本章的接口定义按照第6章的接口定义格式表示。
创建数据库实例
接口名:CreateDBInstance。
描述:创建数据库实例。
参数:见表1。
表1 创建数据库实例接口参数
参数名 描述 类型 选择
BackupRetentionPeriod 自动备份保留的天数 整型 可选
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串 必选
DBInstanceId 数据库实例标识符 字符串 必选
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型 可选
Engine 实例使用的数据库引擎名 字符串 必选
EngineVersion 实例使用的数据库引擎版本 字符串 可选
MasterUserPassword 数据库主用户的密码 字符串 必选
MasterUsername 数据库实例的主用户名称 字符串 必选
Port 应用访问端口 字符串 可选
Region 数据中心 字符串 可选
返回值:见表2。
表2 创建数据库实例接口返回值
参数名 描述 类型
BackupRetentionPeriod 自动备份保留的天数 整型
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串
DBInstanceId 数据库实例标识符 字符串
DBInstanceStatus 数据库实例的当前状态 字符串
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型
Engine 实例使用的数据库引擎名 字符串
2
GB/T32633—2016
满
智
科
技
表2(续)
参数名 描述 类型
EngineVersion 实例使用的数据库引擎版本 字符串
MasterUsername 数据库实例的主用户名称 字符串
InstanceCreateTime 该数据库实例创建的时间 日期时间
Region 数据中心 字符串
错误信息:见表3。
表3 创建数据库实例接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceAlreadyExists 请求参数DBInstanceId指定的数据库实例已存在 400
StorageQuotaExceeded 请求的存储空间大小大于用户可用的存储空间 400
删除数据库实例
接口名:DeleteDBInstance。
描述:删除数据库实例。
参数:见表4。
表4 删除数据库实例接口参数
参数名 描述 类型 选择
DBInstanceId 数据库实例标识符 字符串 必选
返回值:见表5。
表5 删除数据库实例接口返回值
参数名 描述 类型
BackupRetentionPeriod 自动备份保留的天数 整型
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串
DBInstanceId 数据库实例标识符 字符串
DBInstanceStatus 数据库实例的当前状态 字符串
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型
Engine 实例使用的数据库引擎名 字符串
EngineVersion 实例使用的数据库引擎版本 字符串
MasterUsername 数据库实例的主用户名称 字符串
InstanceCreateTime 该数据库实例创建的时间 日期时间
Region 数据中心 字符串
3
GB/T32633—2016
满
智
科
技
错误信息:见表6。
表6 删除数据库实例接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceNotFound 请求参数DBInstanceId指定的数据库实例不存在 404
InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400
修改数据库实例
接口名:ModifyDBInstance。
描述:修改数据库实例。
参数:见表7。
表7 修改数据库实例接口参数
参数名 描述 类型 选择
BackupRetentionPeriod 自动备份保留的天数 整型 可选
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串 可选
DBInstanceId 数据库实例标识符 字符串 必选
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型 可选
EngineVersion 实例使用的数据库引擎版本 字符串 可选
MasterUserPassword 数据库主用户的密码 字符串 必选
NewDBInstanceId 数据库实例的新标识符,用于重命名数据库实例 字符串 可选
返回值:见表8。
表8 修改数据库实例接口返回值
参数名 描述 类型
BackupRetentionPeriod 自动备份保留的天数 整型
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串
DBInstanceId 数据库实例标识符 字符串
DBInstanceStatus 数据库实例的当前状态 字符串
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型
Engine 实例使用的数据库引擎名 字符串
EngineVersion 实例使用的数据库引擎版本 字符串
MasterUsername 数据库实例的主用户名称 字符串
InstanceCreateTime 该数据库实例创建的时间 日期时间
Region 数据中心 字符串
错误信息:见表9。
4
GB/T32633—2016
满
智
科
技
表9 修改数据库实例接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceNotFound 请求参数DBInstanceId指定的数据库实例不存在 404
InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400
StorageQuotaExceeded 请求的存储空间大小大于用户可用的存储空间 400
查看数据库实例
接口名:DescribeDBInstances。
描述:返回关系数据库服务系统实例的相关信息。
参数:见表10。
表10 查看数据库实例接口参数
参数名 描述 类型 选择
DBInstanceId 数据库实例标识符 字符串 可选
返回值:见表11。
表11 查看数据库实例接口返回值
参数名 描述 类型
BackupRetentionPeriod 自动备份保留的天数 整型
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串
DBInstanceId 数据库实例标识符 字符串
DBInstanceStatus 数据库实例的当前状态 字符串
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型
Engine 实例使用的数据库引擎名 字符串
EngineVersion 实例使用的数据库引擎版本 字符串
InstanceCreateTime 该数据库实例创建的时间 日期时间
Port 应用访问端口 字符串
Region 数据中心 字符串
错误信息:见表12。
表12 查看数据库实例接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceNotFound 请求参数DBInstanceId指定的数据库实例不存在 404
重启数据库实例
接口名:RebootDBInstance。
5
GB/T32633—2016
满
智
科
技
描述:重启数据库实例将重启数据库引擎服务。
参数:见表13。
表13 重启数据库实例接口参数
参数名 描述 类型 选择
DBInstanceId 数据库实例标识符 字符串 必选
返回值:见表14。
表14 重启数据库实例接口返回值
参数名 描述 类型
BackupRetentionPeriod 自动备份保留的天数 整型
DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串
DBInstanceId 数据库实例标识符 字符串
DBInstanceStatus 数据库实例的当前状态 字符串
DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型
Engine 实例使用的数据库引擎名 字符串
EngineVersion 实例使用的数据库引擎版本 字符串
MasterUsername 数据库实例的主用户名称 字符串
InstanceCreateTime 该数据库实例创建的时间 日期时间
Region 数据中心 字符串
错误信息:见表15。
表15 重启数据库实例接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceNotFound 请求参数DBInstanceId指定的数据库实例不存在 404
InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400
8 管理接口
概述
本章的接口定义按照第6章的接口定义格式表示。
查看数据库引擎版本
接口名:DescribeDBEngineVersions。
描述:查看可用的数据库引擎。
参数:见表16。
6
GB/T32633—2016
满
智
科
技
表16 查看数据库引擎版本接口参数
参数名 描述 类型 选择
DefaultOnly 指定是否只返回指定引擎的默认版本 布尔型 可选
Engine 数据库引擎名 字符串 可选
EngineVersion 数据库引擎版本 字符串 可选
返回值:见表17。
表17 查看数据库引擎版本接口返回值
参数名 描述 类型
DBEngineDescription 数据库引擎描述 字符串
DBEngineVersionDescription 数据库引擎版本描述 字符串
Engine 数据库引擎名称 字符串
EngineVersion 数据库引擎版本号 字符串
错误信息:无。
查看数据库日志文件
接口名:DescribeDBLogFiles。
描述:返回数据库实例的日志文件。
参数:见表18。
表18 查看数据库日志文件接口参数
参数名 描述 类型 选择
DBInstanceId 需要返回日志文件的数据库实例名 字符串 必选
FileLastWritten 返回的日志文件的起始日期 长整型 可选
FileSize 日志文件大小 长整型 可选
FilenameContains 返回的日志文件名中包含的字符串 字符串 可选
返回值:见表19。
表19 查看数据库日志文件接口返回值
参数名 描述 类型
LastWritten 最近的日志的生成时间 长整型
LogFileName 日志文件名 字符串
Size 日志文件大小 长整型
错误信息:见表20。
7
GB/T32633—2016
满
智
科
技
表20 查看数据库日志文件接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceNotFound 请求参数DBInstanceId指定的数据库实例不存在 404
下载查看数据库日志文件
接口名:DownloadDBLogFilePortion。
描述:下载指定的日志文件。
参数:见表21。
表21 下载查看数据库日志文件接口参数
参数名 描述 类型 选择
DBInstanceId 含有需要下载的日志文件的数据库实例名 字符串 必选
LogFileName 需要下载的日志文件名 字符串 可选
返回值:见表22。
表22 下载查看数据库日志文件接口返回值
参数名 描述 类型
LogFileData 下载的日志文件 字符串
错误信息:见表23。
表23 下载查看数据库日志文件接口错误信息
错误信息 描述 HTTP状态代码
DBInstanceNotFound 请求参数DBInstanceId指定的数据库实例不存在 404
9 共用参数
共用参数是每个分布式关系数据库服务产品接口都需要使用到的请求参数,见表24。
表24 共用参数
参数名 描述 类型 是否必选
Action 执行的操作,即调用的接口名 字符串 是
AccessKeyId 用户访问服务所用的密钥标识 字符串 是
Format 结果返回的格式,可为JSON或XML 字符串 否
Signature 为请求创建的数字签名 字符串 是
SignatureMethod 签名算法 字符串 是
8
GB/T32633—2016
满
智
科
技
表24(续)
参数名 描述 类型 是否必选
SignatureVersion 签名版本 字符串 是
Timestamp 请求的时间戳 字符串 是
Version 服务接口版本号,表达格式为:YYYY-MM-DD 字符串 是
10 共用错误信息
共用错误信息适用于分布式关系数据库服务产品的数据库实例接口和管理接口,见表25。
表25 共用错误信息
错误信息 描述 HTTP状态代码
InternalError 由未知的错误、异常或失效导致请求失败 500
InvalidAction
UnsupportedOperation
请求的操作不可用 400
InvalidParameter 指定的参数不正确 400
MissingParameter 必选的参数缺失 400
ServiceUnavailable 由服务器失效造成的请求失败 503
GB/T32633—2016
满
智
科
技
6102—
33623
T/
B
G
中 华 人 民 共 和 国
国 家 标 准
分布式关系数据库服务接口规范
GB/T32633—2016
*
中 国 标 准 出 版 社 出 版 发 行
北京市朝阳区和平里西街甲2号(100029)
北京市西城区三里河北街16号(100045)
网址:
服务热线:400-168-0010
2016年6月第一版
*
书号:155066·1-54969
版权专有 侵权必究
满
智
科
技
