分布式关系数据库服务接口规范

分布式关系数据库服务接口规范

国家标准 GB/T32633一2016 分布式关系数据库服务接口规范 Distributedrelationaldatabaseserviceinterfacespecifieation 2016-04-25发布 2016-11-01实施 国家质量监督检验检疫总局 发布 国家标准化管理委员会国家标准
GB/T32633一2016 前 言 本标准按照GB/T1.1一2009给出的规则起草 请注意本文件的某些内容可能涉及专利 本文件的发布机构不承担识别这些专利的责任 本标准由全国信息技术标准化技术委员会(SAC/TC28)提出并归口 本标准起草单位:电子技术标准化研究院、清华大学、武汉达梦数据库有限公司 本标准主要起草人:李莹、叶晓俊、曹忠升、卫凤林、张展新 m
GB/T32633一2016 分布式关系数据库服务接口规范 范围 本标准规定了分布式计算环境中关系数据库服务应提供的接口,包括数据库实例接口和管理接口 同时规定分布式关系数据库服务接口的调用方式,共用参数和共用错误信息 本标准适用于运行在分布式计算环境中关系数据库服务的研制和测试 规范性引用文件 下列文件对于本文件的应用是必不可少的 凡是注日期的引用文件,仅注日期的版本适用于本文 件 凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件 ETFRFC2616超文本传输协议HTTP/1.1(Hlypm pertextTransferProtocol HTTP/1.1 术语和定义 下列术语和定义适用于本文件 3.1 数据库实例databaseinstance -个独立占用物理内存的数据库服务进程 缩略语 下列缩略语适用于本文件 HTTP:超文本传输协议(hyper texttrans sferprotocol) avascriptobjectnotation JsON:JavaSerip对象标记(j URL;统一资源定位符(uniformresourcelocators) XML;可扩展置标语言(extensiblenmarkuplanguage) 接口调用方式 5.1请求 应通过IETFRFC2616中规定的HTTP请求格式调用分布式关系数据库服务产品接口,并将请 求参数包含在请求的URL中 5.2返回 调用成功后应以XMl或JsON格式返回结果,调用失败时返回相应的错误信息 接口定义格式 分布式关系数据库服务产品的数据库实例接口和管理接口定义格式如下:
GB/T32633一2016 a)接口名:接口的名称; b 描述:对接口内容的简单描述; 参数:请求调用的参数 c d)返回值:请求返回的内容; 错误信息;调用错误时返回的信息 数据库实例接口 7.1 概述 本章的接口定义按照第6章的接口定义格式表示 7.2 创建数据库实例 接口名:CreateDBInstance 描述;创建数据库实例 参数见表1 创建数据库实例接口参数 参数名 描述 类型 选择 BackupRetentionPeriod 自动备份保留的天数 整型 可选 DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串 必选 DBnstanceld 数据库实例标识符 字符串 必选 为数据库实例初始分配的存储空间大小,以GB为单位 可选 DBlnstanceStorage 整型 实例使用的数据库引擎名 字符串 必选 Engine EngineVersion 实例使用的数据库引擎版本 字符串 可选 数据库主用户的密码 字符串 必选 MasterUserPassword MasterUsername 数据库实例的主用户名称 字符串 必选 Port 应用访问端口 字符串 可选 Region 数据中心 字符串 可选 返回值;见表2 表2创建数据库实例接口返回值 参数名 描述 类型 BackupRetentionPeriod 自动备份保留的天数 整型 DBlnstance(Cla5s 数据库实例类型,指定数据库实例的规格 字符串 数据库实例标识符 字符串 DBlnstanceld 数据库实例的当前状态 字符串 DBInstanceStatus 整型 DBnstanceStorege 为数据库实例初始分配的存储空间大小,以GB为单位 实例使用的数据库引擎名 字符串 Engine
GB/T32633一2016 表2(续 参数名 描述 类型 实例使用的数据库引擎版本 字符串 EngineVersion MasterUsername 数据库实例的主用户名称 字符串 该数据库实例创建的时间 日期时间 Instance(CreateTime 数据中心 字符串 Region 错误信息:见表3 表3创建数据库实例接口错误信息 错误信息 描述 HTTP状态代码 请求参数DBnstaneeld指定的数据库实例已存在 400 DBlnstanceAlreadyExists 请求的存储空间大小大于用户可用的存储空间 400 StorageQuotaExceeded 7.3删除数据库实例 接口名:DeleteDBInstance 描述;删除数据库实例 参数;见表4 表4删除数据库实例接口参数 类型 参数名 描述 选择 DBnstanceld 数据库实例标识符 字符串 必选 返回值;见表5 表5删除数据库实例接口返回值 参数名 描述 类型 自动备份保留的天数 整型 BackupRetentionPeriod DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串 DBnstanceld 数据库实例标识符 字符串 DBlnstanceStatus 字符串 数据库实例的当前状态 DBInstanceStorage 整型 为数据库实例初始分配的存储空间大小,以GB为单位 实例使用的数据库引擎名 Engine 字符串 实例使用的数据库引擎版本 字符串 EngineVersion 数据库实例的主用户名称 字符串 MasterUJsername 该数据库实例创建的时间 日期时间 Instance(Create'Time 数据中心 字符串 Region
GB/T32633一2016 错误信息;见表6 表6删除数据库实例接口错误信息 错误信息 HTTP状态代码 描述 请求参数DBlnstancel eld指定的数据库实例不存在 IDBInstanceNotFound 404 InvalidDBlnstanceState 指定的数据库实例当前为不可用状态 400 7.4 修改数据库实例 接口名:ModifyDBIns nstance 描述;修改数据库实例 参数:见表7 表7修改数据库实例接口参数 参数名 描述 类型 选择 BackupRetentionPeriod 整型 可选 自动备份保留的天数 DBlnstanceClass 数据库实例类型,指定数据库实例的规格 字符串 可选 DBlnstanceld 数据库实例标识符 字符串 必选 DBInstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型 可选 实例使用的数据库引擎版本 EngineVersion 字符串 可选 数据库主用户的密码 字符串 必选 MasterUserPassword 数据库实例的新标识符,用于重命名数据库实例 字符串 可选 NewDBInstanceld 返回值:见表8 表8修改数据库实例接口返回值 参数名 描述 类型 自动备份保留的天数 整型 BackupRetentionPeriod 数据库实例类型,指定数据库实例的规格 字符串 IDBlnstancelass DBnstanceld 数据库实例标识符 字符串 DBnstanceStatus 字符串 数据库实例的当前状态 DBlnstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型 实例使用的数据库引擎名 Engine 字符串 实例使用的数据库引擎版本 字符串 EngineVersion 数据库实例的主用户名称 字符串 MasterUsernamme 该数据库实例创建的时间 日期时间 Instance(Create'Time 数据中心 字符串 Region 错误信息:见表9
GB/T32633一2016 表9修改数据库实例接口错误信息 错误信息 描述 HTTP状态代码 DBInstanceNotFound 请求参数DBn nstance ced指定的数据库实例不存在 404 InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400 StorageQuotaExceeded 请求的存储空间大小大于用户可用的存储空间 00 7.5查看数据库实例 接口名:DeseribeDBInstances, 描述;返回关系数据库服务系统实例的相关信息 参数:见表10. 表10查看数据库实例接口参数 参数名 描述 类型 选择 DBlnstanceld 数据库实例标识符 字符串 可选 返回值;见表11 表11查看数据库实例接口返回值 措描述 类型 参数名 自动备份保留的天数 整型 BackupRetentionPeriod DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串 DBnstanceld 字符串 数据库实例标识符 DBnstanceStatus 数据库实例的当前状态 字符串 DBlnstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型 实例使用的数据库引擎名 字符串 Engine 实例使用的数据库引擎版本 字符串 EngineVersion 该数据库实例创建的时间 日期时间 lnstanceCreateTime 字符串 应用访问端口 Port 数据中心 字符串 Region 错误信息;见表12 表12查看数据库实例接口错误信息 错误信息 描述 HTTP状态代码 请求参数DBlnstanceld指定的数据库实例不存在 DBlnstanceNotFound 404 7.6重启数据库实例 接口名:RebootDBInstaneee
GB/T32633一2016 描述:重启数据库实例将重启数据库引擎服务 参数:见表13 表13重启数据库实例接口参数 选择 参数名 描述 类型 DBnstancela 数据库实例标识符 字符串 必选 返回值:见表14 表14重启数据库实例接口返回值 参数名 描述 类型 自动备份保留的天数 整型 BackupRetentionPeriod DBInstanceClass 数据库实例类型,指定数据库实例的规格 字符串 DBnstancela 数据库实例标识符 字符串 DBInstanceStatus 数据库实例的当前状态 字符串 DBlnstanceStorage 为数据库实例初始分配的存储空间大小,以GB为单位 整型 Engine 实例使用的数据库引擎名 字符串 实例使用的数据库引擎版本 字符串 EngineVersion 数据库实例的主用户名称 字符串 MasterUsername 该数据库实例创建的时间 日期时间 Instance(Create'Time 数据中心 字符串 Region 错误信息;见表15 表15重启数据库实例接口错误信息 描述 错误信息 HTTP状态代码 DBInstanceNotFound 请求参数DBn nstance ced指定的数据库实例不存在 404 InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400 管理接口 8.1 概述 本章的接口定义按照第6章的接口定义格式表示 查看数据库引擎版本 8.2 接口名:DescribeDBEngineVersions 描述:查看可用的数据库引擎 参数:见表16
GB/T32633一2016 表 16查看数据库引擎版本接口参数 参数名 描述 类型 选择 指定是否只返回指定引擎的默认版本 布尔型 可选 DefaultOmly 可选 数据库引擎名 字符串 Engine ngineVersion 数据库引擎版本 字符串 可选 返回值:见表17 表17查看数据库引擎版本接口返回值 类型 参数名 描述 DBEngineDescription 数据库引擎描述 字符串 DBEngineVersionDescriptionm 数据库引擎版本描述 字符串 Engine 数据库引擎名称 字符串 EngineVersion 数据库引擎版本号 字符串 错误信息;无 查看数据库日志文件 8.3 接口名;DescribeDBL.ogFiles 描述;返回数据库实例的日志文件 参数见表18 表18查看数据库日志文件接口参数 参数名 描述 类型 选择 必选 DBlnstanceld 需要返回日志文件的数据库实例名 字符串 长整型 返回的日志文件的起始日期 Filel.astWritten 可选 长整型 可选 ileSize 日志文件大小 返回的日志文件名中包含的字符串 字符串 可选 ilenameContains 返回值:见表19 表19查看数据库日志文件接口返回值 描述 类型 参数名 L.astwrittenm 长整型 最近的日志的生成时间 日志文件名 字符串 LFHiANN ame Size 日志文件大小 长整型 错误信息:见表20.
GB/T32633一2016 表20查看数据库日志文件接口错误信息 错误信息 描述 HTTP状态代码 DBlnstanceNotFound 请求参数DBnstanceld指定的数据库实例不存在 404 下载查看数据库日志文件 接口名:DownloadDBLogFilePo Drtion 描述:下载指定的日志文件 参数见表21 表21下载查看数据库日志文件接口参数 参数名 描述 类型 选择 DBnstanceld 字符串 必选 含有需要下载的日志文件的数据库实例名 l.ogFileName 需要下载的日志文件名 字符串 可选 返回值:见表22" 表22下载查看数据库日志文件接口返回值 参数名 描述 类型 L.ogFileData 下载的日志文件 字符串 错误信息:见表23 表23下载查看数据库日志文件接口错误信息 错误信息 HTTP状态代码 描述 DBInstanceNotFound 请求参数DBnstanceld指定的数据库实例不存在 404 共用参数 共用参数是每个分布式关系数据库服务产品接口都需要使用到的请求参数,见表24 表24共用参数 参数名 描述 类型 是否必选 字符串 Action 执行的操作,即调用的接口名 是 AccessKeyld 用户访问服务所用的密钥标识 字符串 否 Format 结果返回的格式,可为JS(ON或XMl 字符串 Signature 是 为请求创建的数字签名 字符串 签名算法 字符串 SignatureMethod
GB/T32633一2016 表24(续) 是否必选 参数名 描述 类型 签名版本 字符串 SignatureVersion 是 请求的时间戳 字符串 Timestamp 是 Version 服务接口版本号,表达格式为:YYYY-MM-DD 字符串 10 共用错误信息 共用错误信息适用于分布式关系数据库服务产品的数据库实例接口和管理接口,见表25 表25共用错误信息 错误信息 描述 HTTP状态代码 nternalError 由未知的错误、异常或失效导致请求失败 500 lnvalidActionm 请求的操作不可用 400 UnsupportedOperation lnvalidParameter 指定的参数不正确 400 必选的参数缺失 MissingParameter 400 SerwiceUnavailable 由服务器失效造成的请求失败 503

分布式关系数据库服务接口规范GB/T32633-2016详解

GB/T32633-2016是我国国家标准化委员会于2016年12月5日发布的《分布式关系数据库服务接口规范》。该规范旨在统一分布式关系数据库服务接口的规范标准，提高分布式关系数据库的兼容性、互操作性和可扩展性，促进分布式关系数据库的发展。

规范的作用：

GB/T32633-2016《分布式关系数据库服务接口规范》规定了分布式关系数据库服务所必须遵循的接口规范，确保了不同厂商开发的分布式关系数据库之间的互操作性和通用性，为用户提供了更加便捷的使用体验。

适用范围：

GB/T32633-2016适用于基于分布式关系数据库技术的软件产品，包括但不限于数据库管理系统、数据访问组件和数据开发工具等。适用该规范的分布式关系数据库服务应当支持相关接口规范，以实现互操作性和通用性。

术语和定义：

GB/T32633-2016对与分布式关系数据库服务接口相关的术语和定义进行了明确和解释，统一了相关概念，避免了因术语不统一造成的理解偏差和沟通障碍。

通用接口规范：

GB/T32633-2016规定了分布式关系数据库服务必须遵循的通用接口规范，包括连接管理接口、事务管理接口、执行SQL语句接口、结果集管理接口、存储过程管理接口、元数据管理接口等。这些接口规范的制定，保证了不同厂商开发的分布式关系数据库之间的互操作性和通用性。

总结：

GB/T32633-2016《分布式关系数据库服务接口规范》的发布，标志着我国分布式关系数据库服务接口规范化工作的取得重大进展。该规范的出台，将有助于促进分布式关系数据库的发展，提高数据管理和应用系统的稳定性和安全性。

分布式关系数据库服务接口规范的相关资料

和分布式关系数据库服务接口规范类似的标准