ICS 35.240.70 L 67 GP 中华人民共和国国家标准 GB/T32633-2016 分布式关系数据库服务接口规范 Distributed relational database service interface specification 2016-04-25发布 2016-11-01实施 中华人民共和国国家质量监督检验检疫总局 发布 中国国家标准化管理委员会 GB/T 32633-2016 目 次 前言 1 范围 2 规范性引用文件 3 术语和定义 4 缩略语 5 接口调用方式 5.1 请求 5.2 返回 接口定义格式 7 数据库实例接口 7.1 概述 7.2 创建数据库实例 7.3 删除数据库实例 7.4 修改数据库实例 7.5 查看数据库实例 7.6 重启数据库实例 8 管理接口 8.1 概述 8.2 查看数据库引擎版本 8.3 查看数据库日志文件 8.4 下载查看数据库日志文件 共用参数 10 共用错误信息 GB/T 32633-2016 前 本标准按照GB/T1.1一2009给出的规则起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本标准由全国信息技术标准化技术委员会（SAC/TC28)提出并归口。 本标准起草单位：中国电子技术标准化研究院、清华大学、武汉达梦数据库有限公司。 本标准主要起草人：李莹、叶晓俊、曹忠升、卫凤林、张展新。 学兔兔ww摄.bzfxw.com GB/T32633—2016 分布式关系数据库服务接口规范 1范围 本标准规定了分布式计算环境中关系数据库服务应提供的接口，包括数据库实例接口和管理接口， 同时规定分布式关系数据库服务接口的调用方式、共用参数和共用错误信息。 本标准适用于运行在分布式计算环境中关系数据库服务的研制和测试。 2 2规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文 件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 IETFRFC2616超文本传输协议HTTP/1.1(HypertextTransferProtocol- -HTTP/1.1) 3术语和定义 下列术语和定义适用于本文件。 3.1 数据库实例 databaseinstance 一个独立占用物理内存的数据库服务进程。 4缩略语 下列缩略语适用于本文件。 HTTP：超文本传输协议（hypertexttransferprotocol)） JSON:JavaScript对象标记(javascriptobjectnotation)） URL：统一资源定位符（uniformresourcelocators） XML：可扩展置标语言（extensiblemarkuplanguage） 5接口调用方式 5.1请求 求参数包含在请求的URL中。 5.2返回 调用成功后应以XML或JSON格式返回结果，调用失败时返回相应的错误信息。 6接口定义格式 分布式关系数据库服务产品的数据库实例接口和管理接口定义格式如下： 1 学兔兔ww.bzfxw.com GB/T32633—2016 a) 接口名：接口的名称； b) 描述：对接口内容的简单描述； c) 参数：请求调用的参数； d) 返回值：请求返回的内容； e) 错误信息：调用错误时返回的信息。 7 数据库实例接口 7.1 概述 本章的接口定义按照第6章的接口定义格式表示。 7.2 创建数据库实例 接名：CreateDBInstance。 指述：创建数据库实例。 参数，见表1。 表1 创建数据库实例接口参数 参数名 描述 类型 选择 BackupRetentionPeriod 自动备份保留的天数 整型 可选 DBInstanceClass 数据库实例类型，指定数插库实例的规格 字符串 必选 DBInstanceld 数据库实例标识符 字符串 必选 DBInstanceStorage 为数据库实例初始分配的存储空间大小，以GB为单位 整型 可选 Engine 实例使用的数据库引擎名 字符串 必选 EngineVersion 实例使用的数据库引擎版本 字符申 可选 MasterUserPassword 数据库主用户的密码 字符申 必选 MasterUsername 数据库实例的主用户名称 字符申 必选 Port 应用访间端口 字符申 可选 Region 数据中心 字符串 可选 返回值：见表2。 表2创建数据库实例接口返回值 参数名 描述 类型 BackupRetentionPeriod 自动备份保留的天数 整型 DBInstanceClass 数据库实例类型，指定数据库实例的规格 字符串 DBInstanceld 数据库实例标识符 字符串 DBInstanceStetus 数据库实例的当前状态 字符串 DBInstanceStorage 为数据库实例初始分配的存储空间大小，以GB为单位 整型 Engine 实例使用的数据库引擎名 字符串 2 学兔兔ww摄.bzfxw.coM GB/T32633—2016 表2(续) 参数名 描述 类型 EngineVersion 实例使用的数据库引擎版本 字符串 MasterUsername 数据库实例的主用户名称 字符串 InstanceCreateTime 该数据库实例创建的时间 日期时间 Region 数据中心 字符串 错误信息：见表3。 表3 创建数据库实例接口错误信息 错误信息 描述 HTTP状态代码 DBInstanceAlreadyExists 请求参数DBInstanceId指定的数据库实例已存在 400 StorageQuotaExceeded 请求的存储空间大小大于用户可用的存储空间 400 7.3 删除数据库实例 接名：DeleteDBInstance。 描述：删除数据库实例。 参数：见表4。 表4 删除数据库实例接口参数 参数名 描述 类型 选择 DBInstanceld 数据库实例标识符 字符串 必选 返回值：见表5。 表5 删除数据库实例接口返回值 参数名 描述 类型 BackupRetentionPeriod 自动备份保留的天数 整型 DBInstanceClass 数据库实例类型，指定数据库实例的规格 字符串 DBInstanceld 数据库实例标识符 字符串 DBInstanceStatus 数据库实例的当前状态 字符申 DBInstanceStorage 为数据库实例初始分配的存储空间大小，以GB为单位 型 Engine 实例使用的数据库引擎名 字符串 EngineVersion 实例使用的数据库引擎版本 字符串 MasterUsername 数据库实例的主用户名称 字符串 InstanceCreateTime 该数据库实例创建的时间 日期时间 Region 数据中心 字符串 3 学兔兔www.bzfxw.co GB/T326332016 错误信息：见表6。 表6 删除数据库实例接口错误信息 错误信息 描述 HTTP状态代码 DBInstanceNotFound 请求参数DBInstanceld指定的数据库实例不存在 404 InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400 7.4 修改数据库实例 接口名：ModifyDBInstance。 描述：修改数据库实例。 参数：见表7。 表 7 修改数据库实例接口参数 参数名 措述 类型 选择 BackupRetentionPeriod 自动备份保留的天数 整型 可选 DBInstanceClass 数据库实例类型，指定数据库实例的规格 字符串 可选 DBInstanceld 数据库实例标识符 字符串 必选 DBInstanceStorage 为数据库实例初始分配的存储空间大小，以GB为单位 整型 可选 EngineVersion 实例使用的数据库引擎版本 字符串 可选 MasterUserPassword 数据库主用户的密码 字符串 必选 NewDBInstanceld 数据库实例的新标识符，用于重命名数据库实例 字符串 可选 返回值：见表8。 表8 修改数据库实例接口返回值 参数名 类型 BackupRetentionPeriod 自动备份保留的天数 整型 DBInstanceClass 数据库实例类型，指定数据库实例的规格 字符串 DBInstanceld 数据库实例标识符 字符串 DBInstanceStatus 数据库实例的当前状态 字符串 DBInstanceStorage 为数据库实例初始分配的存储空间大小，以GB为单位 整型 Engine 实例使用的数据库引擎名 字符串 EngineVersion 实例使用的数据库引擎版本 字符串 MasterUsername 数据库实例的主用户名称 字符串 InstanceCreateTime 该数据库实例创建的时间 日期时间 Region 数据中心 字符串 错误信息：见表9。 4 学兔兔ww.bzfxw.com GB/T32633—2016 表9 修改数据库实例接口错误信息 错误信息 描述 HTTP状态代码 DBInstanceNotFound 请求参数DBInstanceld指定的数据库实例不存在 404 InvalidDBInstanceState 指定的数据库实例当前为不可用状态 400 StorageQuotaExceeded 请求的存储空间大小大于用户可用的存储空间 400 7.5 查看数据库实例 接口名：DescribeDBInstances。 描述：返回关系数据库服