云数据库 RDS 版

前提条件 已下载Python SDK版本安装包 若未下载安装包，请参考如下步骤： 进入的Python SDK页面。 单击从PyPI上获取安装包。 单击Download files，在右侧下载压缩文件。 请求步骤 发起调用，导入相关产品的SDK。 from aliyunsdkcor…

RDS for MySQL   参数字段 关键字描述 DBName/AccountName accessible，account，action，actual，add，after，against，aggregate，all，algorithm，alter，always，analys…

调用CalculateDBInstanceWeight接口查询系统权重分配值。 在开启的情况下，该接口用于计算系统指定的权重。如果是自定义读权重，请参见。 仅适用于如下实例： MySQL 5.7高可用版（本地SSD盘） MySQL 5.6 SQL Server 2017集群版 调…

调用ModifyReadWriteSplittingConnection接口修改读写分离链路的延迟阈值和各个实例的读权重。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中； 实例中没有正在执行的迁移任务； 实例为如下版本： MySQL 5.7高可用版（本地…

调用ReleaseReadWriteSplittingConnection接口释放读写分离地址。 适用于已经开通读写分离的以下版本实例： MySQL 5.7高可用版（本地SSD盘） MySQL 5.6 SQL Server 2017集群版 调试 前往【】在线调试，API Expl…

调用CreateAccount接口创建管理数据库的账号。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中； 数据库状态为运行中； 没有超出单个实例内的最大账号数量。 说明 该参数仅适用于MySQL、MariaDB、SQL Server（除SQL Serve…

调用DeleteAccount接口删除数据库账号。 调用该接口时，实例状态需要为运行中，否则将操作失败： 说明 该接口暂不支持SQL Server 2017集群版、PostgreSQL、PPAS实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生…

调用DescribeAccounts接口查看实例的帐号信息。 说明 该接口暂不支持SQL Server 2017集群版、PostgreSQL、PPAS实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接…

调用GrantAccountPrivilege接口授权账号访问数据库。 一个账号可授权访问一个或多个数据库。调用该接口时，请确保实例状态为运行中，否则将操作失败。 说明 该接口暂不支持SQL Server 2017集群版、PostgreSQL、PPAS实例。 调试 前往【】在线调…

调用RevokeAccountPrivilege接口撤销账号对数据库的访问权限。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中； 数据库状态为运行中。 说明 具体撤销的权限包括SELECT、INSERT、UPDATE、DELETE、CREATE、DROP…

调用ModifyAccountDescription接口修改数据库账号的描述。 说明 该接口暂不支持SQL Server 2017集群版、PostgreSQL、PPAS实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example…

调用ResetAccountPassword接口重置账号密码。 实例状态需要为运行中，否则操作将失败。 说明 该接口暂不支持对SQL Server 2017集群版、PostgreSQL、PPAS实例通过SQL创建的账号进行密码重置。 调试 前往【】在线调试，API Explore…

调用ResetAccount接口重置高权限账号的权限。 说明 该接口不适用于没有高权限账号的SQL Server 2008 R2实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使…

调用DescribeDBInstanceIPArrayList接口查看RDS实例IP白名单。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求…

调用DescribeDBInstanceSSL接口查询实例SSL设置。 说明 该接口支持MySQL 5.6、MySQL 5.7/8.0高可用本地盘版和SQL Server所有版本。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Exam…

调用DescribeDBInstanceTDE接口查询实例数据加密状态。 该接口用于查看实例的（Transparent Data Encryption，TDE）配置。 说明 该接口只支持MySQL 5.6和SQL Server企业版实例。 调试 前往【】在线调试，API Expl…

调用MigrateSecurityIPMode接口把白名单从通用模式切换为高安全模式。 在通用模式下，白名单中的IP地址不区分经典网络和VPC网络，有安全风险，建议切换为高安全模式； 在高安全模式下，白名单中的IP地址分为两类：VPC的IP地址、经典网络及外网的IP地址。 说明 …

调用ModifyDBInstanceSSL接口修改实例SSL链路。 该接口用于为实例设置（Secure Sockets Layer）加密。 说明 支持MySQL 5.6、MySQL 5.7/8.0高可用本地盘版和SQL Server所有版本。 读写分离地址不支持SSL加密。 调试…

调用ModifyDBInstanceTDE接口修改实例数据加密状态。 该接口用于为实例设置（Transparent Data Encryption，TDE）。 加密密钥由密钥管理服务（KMS）产生和管理，RDS不提供加密所需的密钥和证书。开通TDE后，用户如果要恢复数据到本地，需…

调用ModifySecurityIps接口修改白名单。 调用该接口时，实例状态必须为运行中，否则将操作失败。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈…

调用AllocateInstancePublicConnection接口申请实例的外网地址。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求…

调用DescribeDBInstanceNetInfo接口查看实例的所有连接地址信息。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求参数 …

调用ModifyDBInstanceNetworkExpireTime接口修改连接地址过期时间。 说明 当实例在混访模式下（同时包含VPC连接地址和经典网络连接地址），该接口用于延长保留的经典网络地址过期时间。 调试 前往【】在线调试，API Explorer 提供在线调用 AP…

调用ModifyDBInstanceConnectionString接口修改实例的连接地址和端口。 目前RDS提供内外网两种连接地址，同时也支持混访模式下的专有网络和经典网络地址并存。 说明 仅支持修改连接地址的前缀； 不支持修改读写分离地址。 调试 前往【】在线调试，API E…

调用ModifyDBInstanceNetworkType接口切换RDS实例网络类型。 该接口用于将实例的网络类型从专有网络切换成经典网络，或从经典网络切换成专有网络。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码…

调用ReleaseInstancePublicConnection接口释放实例的外网连接地址。 为了数据安全，不需要外网直接访问数据库时，可以使用该接口释放外网地址。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和…

调用SwitchDBInstanceNetType接口切换内外网地址。 为了节约地址资源，您可以使用该接口进行内外网切换，即原来是内网，则会切换到外网，反之亦然。切换后连接地址会发生变化，需要您修改代码中的连接地址并重启应用。 必须满足以下条件，否则将修改失败： 实例只有内网地址…

调用DescribeSlowLogs查看慢日志统计情况。 说明 该接口暂不支持SQL Server 2017集群版实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API …

调用DescribeSlowLogRecords接口查看实例的慢日志明细。 说明 本接口的返回参数每分钟更新一次。 暂不支持SQL Server类型的实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接…

调用DescribeErrorLogs接口查看实例某段时间内的错误日志。 错误日志包含具体的错误信息和错误日志生成时间。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API …

调用DescribeBinlogFiles接口查看Binlog日志。 当DownloadLink为NULL时，表示RDS没有提供下载链接URL； 当 DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL已设置过期时间 LinkExpiredTime，…

描述 该接口用于查看实例的SQL采集功能是否打开。 注意 该接口暂不支持SQL Server2017集群版实例。 请求参数 名称 类型 是否必须 描述 Action String 是 系统规定参数，取值：DescribeSQLCollectorPolicy。 DBInstance…

调用ModifySQLCollectorPolicy接口开启或关闭实例的SQL审计功能。 支持的实例版本如下： MySQL 5.5 MySQL 5.6 MySQL 5.7高可用本地盘版 SQL Server 2008 R2 PostgreSQL PPAS 调试 前往【】在线调试，…

调用DescribeSQLLogRecords接口查询实例的SQL审计日志。 支持的实例版本如下： MySQL 5.5 MySQL 5.6 MySQL 5.7高可用本地盘版 SQL Server 2008 R2 PostgreSQL PPAS 调试 前往【】在线调试，API Ex…

调用DescribeSQLLogFiles接口查询SQL审计文件列表。 支持的实例版本如下： MySQL 5.5 MySQL 5.6 MySQL 5.7高可用本地盘版 SQL Server 2008 R2 PostgreSQL PPAS 调试 前往【】在线调试，API Explo…

调用CreateBackup接口为实例创建一个备份集。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中； 没有正在执行中的备份任务； 单个实例一天内可创建的备份集数量不超过20个。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动…

调用CloneDBInstance接口将历史数据恢复至一个新实例（称为克隆实例）。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中； 实例当前没有正在执行的迁移任务； 实例已开启日志备份（用于按时间点恢复）； 若要按备份集克隆实例，则主实例必须至少有一个已…

调用DescribeBackups接口查看备份集列表。 说明 备份集的状态BackupStatus必须是Success，才能用于恢复。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使…

调用CreateTempDBInstance接口创建临时实例。 基于备份集或者7天内的一个时间点创建临时实例。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例为SQL Server 2012/2016基础版或SQL Server 2008 R2版； 实例状态为运行中；…

调用DescribeBackupPolicy接口查看实例备份设置。 RDS实例将根据用户设置的备份设置，定期做备份。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难…

调用ModifyBackupPolicy接口修改备份设置。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例不能为只读实例； 实例状态为运行中。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口…

调用RestoreDBInstance接口恢复备份集到原实例（覆盖性恢复），已下线。 说明 该API已下线。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈…

调用DeleteBackup接口删除数据备份文件。 调用该接口删除数据备份文件只删除实例自身的备份集，不会删除所关联实例（只读、灾备、克隆等）的备份集。 调用该接口时，实例必须满足以下条件，否则将操作失败： 实例状态为运行中； 实例为MySQL、PostgreSQL、PPAS的高…

调用DescribeBackupDatabase接口查询备份集下的数据库列表，已下线。 说明 该API已下线。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强…

调用DescribeBackupTasks接口查询实例的备份任务列表。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求参数 名称 类型 是否…

调用DescribeLogBackupFiles接口查询实例的日志备份文件。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求参数 名称 类型…

调用RecoveryDBInstance接口恢复数据库。 恢复数据库，分为恢复到已有实例和恢复到新实例两种业务场景。 恢复到已有实例：支持将原实例中的部分库，恢复到已有实例中（可以是原实例或者同地域其他实例），若库名重复则必须要用新库名，即不支持覆盖性恢复原库。 恢复到新实例：先…

调用CheckCreateDdrDBInstance接口预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SD…

调用CreateDdrInstance接口跨地域恢复数据到新实例。 恢复前可以调用接口预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer 提供在…

调用DescribeAvailableCrossRegion接口查询所选地域当前可以进行跨地域备份的目的地域。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强…

调用DescribeAvailableRecoveryTime接口查询某跨地域备份文件可恢复哪个时间段的数据。 查看普通备份文件可恢复哪个时间段的数据请参见。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Expl…

调用DescribeCrossRegionBackupDBInstance接口查询所选地域的哪些实例开启了跨地域备份，以及这些实例的跨地域备份设置。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer …

调用DescribeCrossRegionBackups接口查看某RDS实例跨地域数据备份文件列表。 查看日志备份文件请参见。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer 提供在线调用 API、…

调用DescribeCrossRegionLogBackupFiles接口查看跨地域日志备份文件列表。 查看数据备份文件请参见。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer 提供在线调用 API…

调用DescribeInstanceCrossBackupPolicy接口查询跨地域备份设置。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example…

调用ModifyInstanceCrossBackupPolicy接口修改RDS跨地域备份设置。 仅适用于如下实例： MySQL 5.7高可用本地SSD盘版 MySQL 5.6 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Exampl…

调用CreateMigrateTask接口将OSS上的备份文件还原到RDS实例，实现数据上云。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请…

在备份数据上云时调用CreateOnlineDatabaseTask接口打开数据库。 本接口用于备份数据上云，建议您先查看或，了解流程后再使用本接口。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能…

调用DescribeMigrateTasks接口查询备份数据上云任务列表。 该接口可以查询实例在最近一周内的备份数据上云任务记录。 说明 备份数据上云的源备份文件必须是全量备份（FULL）文件。 暂不支持SQL Server 2017集群版实例。 调试 前往【】在线调试，API …

调用DescribeOssDownloads接口查看备份数据上云任务的文件详情。 说明 该接口暂不支持SQL Server 2017集群版实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能…

调用DescribeResourceUsage接口查看实例的空间利用信息。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求参数 名称 类型 …

调用DescribeDBInstancePerformance接口查看实例性能数据。 根据性能参数查看某个实例、某时间段范围内的性能监控数据。根据查询时间范围的不同，有如下3种输出形式： 查询时间范围小于等于1天，采集粒度为5分钟； 查询时间范围大于7天小于等于15天，采集粒度为…

调用DescribeDBInstanceMonitor接口查询监控频率。 调试 前往【】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。 请求参数 名称 类型 是…

调用ModifyDBInstanceMonitor修改监控频率。 请确保在使用该接口前，已充分了解RDS产品的收费方式和 。 阿里云对不同实例提供不同的监控频率，详情请参见 。 说明 秒级监控需要收取额外费用。 调试 前往【】在线调试，API Explorer 提供在线调用 AP…

调用DescribeParameterTemplates接口查看数据库参数模板。 该接口适用的实例版本如下： MySQL 5.5/5.6/5.7/8.0 SQL Server 2008 R2 PostgreSQL 9.4/10.0 PPAS 9.3/10.0 MariaDB 10…

调用DescribeParameters接口查询实例当前的参数配置。 该接口适用的实例版本如下： MySQL 5.5/5.6/5.7/8.0 SQL Server 2008 R2 PostgreSQL 9.4/10.0 PPAS 9.3/10.0 MariaDB 10.3 调试 …

调用ModifyParameter接口修改实例参数。 调用该接口时，实例状态必须为运行中，否则将操作失败。 可以修改的参数请在控制台查看，请参见。 提交修改请求后，RDS将下发任务，将新修改的参数应用到实例，如果所提交的参数中有需要重启数据库的，RDS将重启数据库。 下达任务之前…

创建文件服务器的账号、密码以及上传文件的路径信息。您可以根据此信息，可上传数据文件，待上传完成，调用导入数据接口，进行外部数据迁移操作。 需满足以下条件，否则操作将失败： 该接口只适用于RDS for SQLServer类型的实例。 实例状态为运行中。 数据库状态为运行中。 一个…

查看文件服务器的文件列表。 通过该接口，您可以得到文件服务器上传账号。在数据文件上传结束后，RDS会更新数据文件状态。通过改接口，也可以查看数据文件是否可用。如果文件可用，则可以进行数据导入，并得到导入过程信息。 说明 该接口只适用于RDS for SQL Server（除SQL…

查看SQL Server数据库导入列表以及导入任务情况，判断导入任务是否完成。 注意 该接口暂不支持SQL Server2017集群版实例。 请求参数 名称 类型 是否必须 描述 Action String 是 要执行的操作，取值： DescribeImportsForSQLSe…

调用ImportDatabaseBetweenInstances接口从其它RDS实例迁入数据。 迁移过程中，源实例的状态处于迁移中，目标实例的状态处于数据导入中。 调用该接口时，实例必须满足以下条件，否则将操作失败： 仅支持MySQL和SQL Server的独享和独占规格的实例，…

调用CancelImport接口用于取消RDS实例迁移任务。 支持MySQL和SQL Server的独享和独占规格的实例。发起迁移任务请参见。 说明 该接口暂不支持SQL Server 2017 集群版实例。 调试 前往【】在线调试，API Explorer 提供在线调用 API…

调用AddTagsToResource接口为实例绑定标签。 为实例绑定已有的或新创建的标签，限制如下： 每个标签（Tag）由标签键（TagKey）和标签值（TagValue）组成，TagKey不能为空，TagValue可以为空； TagKey和TagValue的值不允许以aliy…

调用DescribeTags接口查询RDS实例的标签。 调用本接口时限制条件如下： 如果传入指定实例ID，则查询该实例下所有标签，其他过滤条件失效； 若查询标签时仅传入标签键（TagKey），未传入标签值（TagValue），则返回所有符合标签键条件的结果。若同时传入标签键和标签…

调用RemoveTagsFromResource接口解绑标签。 限制条件如下： 单次最多支持解绑10个标签； 若一个标签所绑定的实例全都解绑，则该标签自动删除； 若解绑标签时仅传入标签键（TagKey），未传入标签值（TagValue），则解绑所有符合标签键条件的标签。 必须传入…

描述 您通过云账号创建的RDS实例，都是该账号自己拥有的资源。默认情况下，账号对自己的资源拥有完整的操作权限。 通过使用阿里云的RAM（Resource Access Management）服务，您可以将您云账号下RDS资源的访问及管理权限授予RAM中的子用户。 目前，可以在RA…

公共错误   错误代码 描述 HTTP状态码 MissingParameter The input parameter “parameter name” that is mandatory for processing this request is not supplied. …

错误代码 描述 HTTP状态码 ServiceUnavailable The request has failed due to a temporary failure of the server. 503 InternalError The request processing…

状态 说明 Creating 创建中 Running 使用中 Deleting 删除中 Rebooting 重启中 DBInstanceClassChanging 升降级中 TRANSING 迁移中 EngineVersionUpgrading 迁移版本中 TransingToO…

RDS for MySQL API参数名 含义 MySQL_NetworkTraffic MySQL实例平均每秒钟的输入流量，MySQL实例平均每秒钟的输出流量。单位为KB。 MySQL_QPSTPS 平均每秒SQL语句执行次数，平均每秒事务数。 MySQL_Sessions 当…

阿里云关系型数据库RDS（Relational Database Service）支持以下类型的SDK： Java SDK Python SDK PHP SDK .NET SDK C/C++ SDK Go SDK

如果您初次使用阿里云关系型数据库RDS，请参阅快速入门系列文档，帮助您快速上手RDS。 数据库引擎 以下是对五种数据库引擎的介绍： 云数据库RDS for MySQL MySQL是全球最受欢迎的开源数据库，作为开源软件组合LAMP（Linux + Apache + MySQL +…