jdcloud_sdk.services.rds.apis package

Submodules

jdcloud_sdk.services.rds.apis.ClearBinlogsRequest module

class jdcloud_sdk.services.rds.apis.ClearBinlogsRequest.ClearBinlogsParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.ClearBinlogsRequest.ClearBinlogsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

清理本地的binlog并释放空间。 系统只会清理已经备份到存储的binlog,不会影响MySQL实例的备份恢复<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.CopyParameterGroupRequest module

class jdcloud_sdk.services.rds.apis.CopyParameterGroupRequest.CopyParameterGroupParameters(regionId, parameterGroupId, parameterGroupName)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – 参数组ID
  • parameterGroupName – 参数组的名字
setDescription(description)[source]
Parameters:description – (Optional) 参数组的描述
class jdcloud_sdk.services.rds.apis.CopyParameterGroupRequest.CopyParameterGroupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

拷贝参数组

jdcloud_sdk.services.rds.apis.CreateAccountRequest module

class jdcloud_sdk.services.rds.apis.CreateAccountRequest.CreateAccountParameters(regionId, instanceId, accountName, accountPassword)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • accountName – 账号名,在同一个RDS实例中,账号名不能重复。账号名的具体规则可参见帮助中心文档:[名称及密码限制](../../../documentation/Database-and-Cache-Service/RDS/Introduction/Restrictions/SQLServer-Restrictions.md)
  • accountPassword – 密码,密码的具体规则可参见帮助中心文档:[名称及密码限制](../../../documentation/Database-and-Cache-Service/RDS/Introduction/Restrictions/SQLServer-Restrictions.md)
setNotes(notes)[source]
Parameters:notes – (Optional) 备注信息,仅支持PostgreSQL
class jdcloud_sdk.services.rds.apis.CreateAccountRequest.CreateAccountRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建数据库账号,用户可以使用客户端,应用程序等通过该账号和密码登录RDS数据库实例。<br>为便于管理和恢复,RDS对账号进行了限制,数据库账号只能通过控制台或者OpenAPI进行创建、删除账号以及对账号授权等,用户不能通过SQL语句对账号进行相关操作。

jdcloud_sdk.services.rds.apis.CreateAuditRequest module

class jdcloud_sdk.services.rds.apis.CreateAuditRequest.CreateAuditParameters(regionId, instanceId, enabled)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • enabled – 要开启的审计选项,各个选项之间用英文逗号或空格进行分割,例如:DATABASE_OBJECT_ACCESS_GROUP,ACKUP_RESTORE_GROU等<br>各个数据库版本支持的审计选项可以通过接口[describeAuditOptions](./describeAuditOptions.md)获得,各个审计项的具体含义可以参看微软的官方文档
class jdcloud_sdk.services.rds.apis.CreateAuditRequest.CreateAuditRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

开启SQL Server的数据库审计功能,目前支持实例级的数据库审计。用户可以根据需要开启、关闭审计、自定义审计策略,并下载审计文件。审计文件为原生的SQL Server审计文件,缺省保存6个月。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.CreateBackupRequest module

class jdcloud_sdk.services.rds.apis.CreateBackupRequest.CreateBackupParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
setBackupSpec(backupSpec)[source]
Parameters:backupSpec – (Optional) 备份规格
setInstanceId(instanceId)[source]
Parameters:instanceId – (Optional) RDS实例ID,唯一标识一个实例
class jdcloud_sdk.services.rds.apis.CreateBackupRequest.CreateBackupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一个RDS实例全量备份,可以对整个实例或者部分数据库(仅SQL Server支持)进行全量备份。同一时间点,只能有一个正在运行的备份任务

jdcloud_sdk.services.rds.apis.CreateBackupSynchronicityRequest module

class jdcloud_sdk.services.rds.apis.CreateBackupSynchronicityRequest.CreateBackupSynchronicityParameters(regionId, instanceId, destRegion)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – 源实例ID
  • destRegion – 备份同步的目标地域
class jdcloud_sdk.services.rds.apis.CreateBackupSynchronicityRequest.CreateBackupSynchronicityRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一个跨地域备份同步服务。

jdcloud_sdk.services.rds.apis.CreateDatabaseRequest module

class jdcloud_sdk.services.rds.apis.CreateDatabaseRequest.CreateDatabaseParameters(regionId, instanceId, dbName, characterSetName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • dbName – 数据库名,数据库名称的限制请参考[帮助中心文档](../../../documentation/Database-and-Cache-Service/RDS/Introduction/Restrictions/SQLServer-Restrictions.md)
  • characterSetName – 数据库的字符集名,当前支持的字符集请查看[枚举参数定义](../Enum-Definitions/Enum-Definitions.md)
class jdcloud_sdk.services.rds.apis.CreateDatabaseRequest.CreateDatabaseRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一个数据库。 为了实例的管理和数据恢复,RDS对用户权限进行了限制,用户仅能通过控制台或本接口创建数据库

jdcloud_sdk.services.rds.apis.CreateInstanceByTimeRequest module

class jdcloud_sdk.services.rds.apis.CreateInstanceByTimeRequest.CreateInstanceByTimeParameters(regionId, instanceId, restoreTime, instanceSpec)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • restoreTime – 根据源实例的哪个时间点创建新实例
  • instanceSpec – 新建实例规格
class jdcloud_sdk.services.rds.apis.CreateInstanceByTimeRequest.CreateInstanceByTimeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据源实例备份创建一个新实例,并通过追加日志的方式,将新实例的数据恢复到跟源实例指定时间点的数据状态一样。<br>例如根据实例A在“2018-06-18 23:00:00”时间点创建一个实例B,就是新建一个实例B,该实例B的数据跟实例A在“2018-06-18 23:00:00”这个时间点的数据完全一致。<br>对于SQL Server,主备切换后30分钟内,不支持按时间点恢复/创建,例如在10:05分用户进行了主备切换,那么10:05 ~ 10:35这个时间段不能进行按时间点恢复/创建。

jdcloud_sdk.services.rds.apis.CreateInstanceFromBackupRequest module

class jdcloud_sdk.services.rds.apis.CreateInstanceFromBackupRequest.CreateInstanceFromBackupParameters(regionId, backupId, engine, instanceSpec)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • backupId – 备份ID
  • engine – 标识是创建什么类型的实例,例如MySQL,SQL Server等,具体可参见文档[枚举参数定义](../Enum-Definitions/Enum-Definitions.md)<br>**注意:备份来源实例的engine和要创建的实例的engine必须一致**
  • instanceSpec – 新建实例规格
class jdcloud_sdk.services.rds.apis.CreateInstanceFromBackupRequest.CreateInstanceFromBackupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据源实例全量备份创建一个新实例,新实例的数据跟源实例在创建备份时的数据状态一样。<br>例如根据源实例A的一个全量备份“mybak”新建一个实例B,该备份是在“‘2018-8-18 03:23:54”创建的。那么新建实例B的数据状态跟实例A‘2018-8-18 03:23:54’的状态一致

jdcloud_sdk.services.rds.apis.CreateInstanceRequest module

class jdcloud_sdk.services.rds.apis.CreateInstanceRequest.CreateInstanceParameters(regionId, instanceSpec)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceSpec – 新建实例规格
class jdcloud_sdk.services.rds.apis.CreateInstanceRequest.CreateInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一个RDS实例,用户可以使用相应的数据库客户端或者应用程序通过域名和端口链接到该RDS实例上,进行操作。

jdcloud_sdk.services.rds.apis.CreateParameterGroupRequest module

class jdcloud_sdk.services.rds.apis.CreateParameterGroupRequest.CreateParameterGroupParameters(regionId, engine, engineVersion, parameterGroupName)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • engine – 实例引擎类型,参见[枚举参数定义](../Enum-Definitions/Enum-Definitions.md)
  • engineVersion – 实例引擎版本,参见[枚举参数定义](../Enum-Definitions/Enum-Definitions.md)
  • parameterGroupName – 参数组的名字
setDescription(description)[source]
Parameters:description – (Optional) 参数组的描述
class jdcloud_sdk.services.rds.apis.CreateParameterGroupRequest.CreateParameterGroupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一个参数组<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.DeleteAccountRequest module

class jdcloud_sdk.services.rds.apis.DeleteAccountRequest.DeleteAccountParameters(regionId, instanceId, accountName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • accountName – 账号名,在同一个实例中账号名不能重复
class jdcloud_sdk.services.rds.apis.DeleteAccountRequest.DeleteAccountRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除数据库账号,账号删除后不可恢复,用户无法再使用该账号登录RDS实例

jdcloud_sdk.services.rds.apis.DeleteAuditRequest module

class jdcloud_sdk.services.rds.apis.DeleteAuditRequest.DeleteAuditParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DeleteAuditRequest.DeleteAuditRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

关闭数据库审计。关闭数据库审计后,以前生成的审计结果文件并不会被立即删除。审计结果文件会过期后由系统自动删除,过期时间缺省为6个月<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DeleteBackupRequest module

class jdcloud_sdk.services.rds.apis.DeleteBackupRequest.DeleteBackupParameters(regionId, backupId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • backupId – 备份ID
class jdcloud_sdk.services.rds.apis.DeleteBackupRequest.DeleteBackupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除RDS实例备份,仅允许删除用户生成的备份,系统自动备份不允许删除。

jdcloud_sdk.services.rds.apis.DeleteBackupSynchronicityRequest module

class jdcloud_sdk.services.rds.apis.DeleteBackupSynchronicityRequest.DeleteBackupSynchronicityParameters(regionId, serviceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • serviceId – 跨地域备份同步服务ID
class jdcloud_sdk.services.rds.apis.DeleteBackupSynchronicityRequest.DeleteBackupSynchronicityRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除一个跨地域备份同步服务。

jdcloud_sdk.services.rds.apis.DeleteDatabaseRequest module

class jdcloud_sdk.services.rds.apis.DeleteDatabaseRequest.DeleteDatabaseParameters(regionId, instanceId, dbName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • dbName – 库名称
class jdcloud_sdk.services.rds.apis.DeleteDatabaseRequest.DeleteDatabaseRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

从RDS实例中删除数据库。为便于管理和数据恢复,RDS对用户权限进行了控制,用户仅能通过控制台或本接口删除数据库 [MFA enabled]

jdcloud_sdk.services.rds.apis.DeleteImportFileRequest module

class jdcloud_sdk.services.rds.apis.DeleteImportFileRequest.DeleteImportFileParameters(regionId, instanceId, fileName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • fileName – 单库上云文件名
setSharedFileGid(sharedFileGid)[source]
Parameters:sharedFileGid – (Optional) 共享文件的全局ID,可从上传文件查询接口describeImportFiles中获取;如果该文件不是共享文件,则无须输入该字段
class jdcloud_sdk.services.rds.apis.DeleteImportFileRequest.DeleteImportFileRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除用户通过单库上云工具上传的数据库备份文件<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DeleteInstanceRequest module

class jdcloud_sdk.services.rds.apis.DeleteInstanceRequest.DeleteInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DeleteInstanceRequest.DeleteInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除一个RDS实例或者MySQL/PostgreSQL的只读实例。删除MySQL/PostgreSQL主实例时,会同时将对应的MySQL/PostgreSQL只读实例也删除 [MFA enabled]

jdcloud_sdk.services.rds.apis.DeleteParameterGroupRequest module

class jdcloud_sdk.services.rds.apis.DeleteParameterGroupRequest.DeleteParameterGroupParameters(regionId, parameterGroupId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – Parameter Group ID
class jdcloud_sdk.services.rds.apis.DeleteParameterGroupRequest.DeleteParameterGroupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除参数组<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.DescribeAccountsRequest module

class jdcloud_sdk.services.rds.apis.DescribeAccountsRequest.DescribeAccountsParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为100,取值范围:[10,100],用于查询列表的接口
class jdcloud_sdk.services.rds.apis.DescribeAccountsRequest.DescribeAccountsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看某个RDS实例下所有账号信息,包括账号名称、对各个数据库的访问权限信息等

jdcloud_sdk.services.rds.apis.DescribeActiveQueryPerformanceRequest module

class jdcloud_sdk.services.rds.apis.DescribeActiveQueryPerformanceRequest.DescribeActiveQueryPerformanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setDb(db)[source]
Parameters:db – (Optional) 需要查询的数据库名,多个数据库名之间用英文逗号分隔,默认所有数据库
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞]。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为50,取值范围:[1,100],只能为10的倍数
setThreshold(threshold)[source]
Parameters:threshold – (Optional) 返回执行时间大于等于threshold的记录,默认10,单位秒
class jdcloud_sdk.services.rds.apis.DescribeActiveQueryPerformanceRequest.DescribeActiveQueryPerformanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据用户定义的查询条件,获取正在执行中的SQL执行的性能信息。用户可以根据这些信息查找与SQL执行相关的性能瓶颈,并进行优化。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeAuditDownloadURLRequest module

class jdcloud_sdk.services.rds.apis.DescribeAuditDownloadURLRequest.DescribeAuditDownloadURLParameters(regionId, instanceId, fileName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • fileName – 审计文件名
class jdcloud_sdk.services.rds.apis.DescribeAuditDownloadURLRequest.DescribeAuditDownloadURLRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取某个审计文件的下载链接,同时支持内链和外链,链接的有效时间为24小时<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeAuditFilesRequest module

class jdcloud_sdk.services.rds.apis.DescribeAuditFilesRequest.DescribeAuditFilesParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeAuditFilesRequest.DescribeAuditFilesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取当前实例下的所有审计结果文件的列表<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeAuditOptionsRequest module

class jdcloud_sdk.services.rds.apis.DescribeAuditOptionsRequest.DescribeAuditOptionsParameters(regionId, instanceId, name)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • name – 审计选项类别,大小写敏感,目前支持两种类型:<br>(1)AuditOptions开头:在disalbed参数中返回SQL Server各个版本支持的所有选项,支持的名称为<br>AuditOptions2008R2<br>AuditOptions2012<br>AuditOptions2014<br>AuditOptions2016<br>例如输入参数为”AuditOptions2016”,则在disabled字段中返回SQL Server 2016 版本所支持的所有的审计选项<br>(2)AuditDefault开头:京东云建议的默认选项,在enabled参数中返回建议开启的选项,在disabled参数中返回不开启的选项,支持的名称为:<br>AuditDefault2008R2<br>AuditDefault2012<br>AuditDefault2014<br>AuditDefault2016<br>例如输入参数为”AuditDefault2016”,则在enabled字段返回SQL Server 2016 版本中京东云建议开启的审计选项,在disabled字段中返回建议不开启的选项
class jdcloud_sdk.services.rds.apis.DescribeAuditOptionsRequest.DescribeAuditOptionsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取当前系统所支持的各种数据库版本的审计选项及相应的推荐选项<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeAuditRequest module

class jdcloud_sdk.services.rds.apis.DescribeAuditRequest.DescribeAuditParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeAuditRequest.DescribeAuditRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看当前实例已开启的审计选项。如当前实例未开启审计,则返回空<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeAuditResultRequest module

class jdcloud_sdk.services.rds.apis.DescribeAuditResultRequest.DescribeAuditResultParameters(regionId, instanceId, startTime, endTime)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • startTime – 查询开始时间,格式为:YYYY-MM-DD HH:mm:ss,开始时间不能早于当前时间3天
  • endTime – 查询截止时间,格式为:YYYY-MM-DD HH:mm:ss,开始时间到结束时间不能超过3天
setAccountName(accountName)[source]
Parameters:accountName – (Optional) 废弃,使用filter,账号名
setDbName(dbName)[source]
Parameters:dbName – (Optional) 废弃,使用filter,数据库名
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and支持以下属性的过滤(默认等值):)
  • operation:仅第一个value生效,语句类型【create/alter/drop/truncate/select/insert/update/delete/replace/ddl/dml/disconnect/connect/failed_connect/query】,operator仅支持eq或者in
  • account:实例账号名,operator仅支持eq或者in
  • keyword:SQL 关键词,模糊查询,operator仅支持eq或者in
  • database:实例库名,operator仅支持eq或者in
  • threadId:会话id,operator仅支持eq或者in
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100]
class jdcloud_sdk.services.rds.apis.DescribeAuditResultRequest.DescribeAuditResultRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看RDS实例的审计内容<br>- 仅支持 MySQL 5.6, MySQL 5.7, Percona, MariaDB, PostgreSQL

jdcloud_sdk.services.rds.apis.DescribeAzsRequest module

class jdcloud_sdk.services.rds.apis.DescribeAzsRequest.DescribeAzsParameters(regionId, engine)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • engine – RDS引擎类型,参见[枚举参数定义](../Enum-Definitions/Enum-Definitions.md)
class jdcloud_sdk.services.rds.apis.DescribeAzsRequest.DescribeAzsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看指定地域下各种RDS数据库支持的可用区,不同类型的RDS支持的可用区不一样

jdcloud_sdk.services.rds.apis.DescribeBackupDownloadURLRequest module

class jdcloud_sdk.services.rds.apis.DescribeBackupDownloadURLRequest.DescribeBackupDownloadURLParameters(regionId, backupId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • backupId – 备份ID
setFileName(fileName)[source]
Parameters:fileName – (Optional) 文件名称<br>- MySQL:不支持该参数<br>- SQL Server:必须输入该参数,指定该备份中需要获取下载链接的文件名称。备份中的文件名(不包括后缀)即为备份的数据库名。例如文件名为my_test_db.bak,表示该文件是my_test_db数据库的备份
setUrlExpirationSecond(urlExpirationSecond)[source]
Parameters:urlExpirationSecond – (Optional) 指定下载链接的过期时间,单位秒, 取值范围为 1 ~ 86400 秒;支持 SQL Server:缺省为 86400 秒。支持 MySQL, Percona, MariaDB:缺省为 300 秒。
class jdcloud_sdk.services.rds.apis.DescribeBackupDownloadURLRequest.DescribeBackupDownloadURLRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取整个备份或备份中单个文件的下载链接。<br>- 当输入参数中有文件名时,获取该文件的下载链接。<br>- 输入参数中无文件名时,获取整个备份的下载链接。<br>由于备份机制的差异,使用该接口下载备份时,SQL Server必须输入文件名,每个文件逐一下载,不支持下载整个备份。SQL Server备份中的文件名(不包括后缀)即为备份的数据库名。例如文件名为my_test_db.bak,表示该文件是my_test_db数据库的备份。<br>MySQL可下载整个备份集,但不支持单个文件的下载。

jdcloud_sdk.services.rds.apis.DescribeBackupPolicyRequest module

class jdcloud_sdk.services.rds.apis.DescribeBackupPolicyRequest.DescribeBackupPolicyParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeBackupPolicyRequest.DescribeBackupPolicyRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看RDS实例备份策略。根据数据库类型的不同,支持的备份策略也略有差异,具体请看返回参数中的详细说明

jdcloud_sdk.services.rds.apis.DescribeBackupSynchronicitiesRequest module

class jdcloud_sdk.services.rds.apis.DescribeBackupSynchronicitiesRequest.DescribeBackupSynchronicitiesParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[1,∞),用于查询列表的接口
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:10、20、30、50、100
class jdcloud_sdk.services.rds.apis.DescribeBackupSynchronicitiesRequest.DescribeBackupSynchronicitiesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询跨地域备份同步服务列表。

jdcloud_sdk.services.rds.apis.DescribeBackupsRequest module

class jdcloud_sdk.services.rds.apis.DescribeBackupsRequest.DescribeBackupsParameters(regionId, instanceId, pageNumber, pageSize)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS实例ID,唯一标识一个实例
  • pageNumber – 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
  • pageSize – 每页显示的数据条数,默认为10,取值范围:[10,100]
setAuto(auto)[source]
Parameters:auto – (Optional) 查询备份类型,0为手动备份,1为自动备份,不传表示全部. <br>**- 测试参数,仅支持SQL Server,后续可能被其他参数取代**
setBackupTimeRangeEndFilter(backupTimeRangeEndFilter)[source]
Parameters:backupTimeRangeEndFilter – (Optional) 返回备份开始时间小于等于该时间的备份列表<br>**- 测试参数,仅支持SQL Server,后续可能被其他参数取代**
setBackupTimeRangeStartFilter(backupTimeRangeStartFilter)[source]
Parameters:backupTimeRangeStartFilter – (Optional) 返回备份开始时间大于该时间的备份列表<br>**- 测试参数,仅支持SQL Server,后续可能被其他参数取代**
setBackupTypeFilter(backupTypeFilter)[source]
Parameters:backupTypeFilter – (Optional) 返回backupType等于指定值的备份列表。full为全量备份,diff为增量备份<br>**- 测试参数,仅支持SQL Server,后续可能被其他参数取代**
setDbNameFilter(dbNameFilter)[source]
Parameters:dbNameFilter – (Optional) 返回dbName等于指定值的备份列表,不传或为空返回全部<br>**- 测试参数,仅支持SQL Server,后续可能被其他参数取代**
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and支持以下属性的过滤(默认等值):)
  • instanceId:RDS实例ID,唯一标识一个实例,operator仅支持eq
  • instanceName:RDS实例名称,模糊搜索,operator仅支持eq、like
  • backupId:备份ID,唯一标识一个备份,operator仅支持eq
  • backupName:备份名称,模糊搜索,operator仅支持eq、like
  • auto:备份类型,0为手动备份,1为自动备份,operator仅支持eq
  • backupMethod:返回backupMethod等于指定值的备份列表,physical为物理备份,snapshot为快照备份备注,operator仅支持eq
class jdcloud_sdk.services.rds.apis.DescribeBackupsRequest.DescribeBackupsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看该RDS实例下所有备份的详细信息,返回的备份列表按照备份开始时间(backupStartTime)降序排列。

jdcloud_sdk.services.rds.apis.DescribeBinlogDownloadURLRequest module

class jdcloud_sdk.services.rds.apis.DescribeBinlogDownloadURLRequest.DescribeBinlogDownloadURLParameters(regionId, instanceId, binlogBackupId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • binlogBackupId – binlog的备份ID,可以通过describeBinlogs获得
setSeconds(seconds)[source]
Parameters:seconds – (Optional) 设置链接地址的过期时间,单位是秒,默认值是 300 秒,最长不能超过取值范围为 1 ~ 86400 秒
class jdcloud_sdk.services.rds.apis.DescribeBinlogDownloadURLRequest.DescribeBinlogDownloadURLRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取MySQL实例的binlog的下载链接<br>- 仅支持 MySQL, Percona, MariaDB

jdcloud_sdk.services.rds.apis.DescribeBinlogsRequest module

class jdcloud_sdk.services.rds.apis.DescribeBinlogsRequest.DescribeBinlogsParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setEndTime(endTime)[source]
Parameters:endTime – (Optional) 查询结束时间,格式为:YYYY-MM-DDTHH:mm:ssZ,开始时间到结束时间不超过7天
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and支持以下属性的过滤(默认等值):)
  • instanceId:RDS实例ID,唯一标识一个实例,operator仅支持eq
  • instanceName:RDS实例名称,模糊搜索,operator仅支持eq、like
  • binlogId:Binlog ID,唯一标识一个备份,operator仅支持eq
  • binlogName:Binlog名称,模糊搜索,operator仅支持eq、like
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100]
setStartTime(startTime)[source]
Parameters:startTime – (Optional) 查询开始时间,格式为:YYYY-MM-DDTHH:mm:ssZ,开始时间到结束时间不超过7天
class jdcloud_sdk.services.rds.apis.DescribeBinlogsRequest.DescribeBinlogsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取MySQL实例中binlog的详细信息<br>- 仅支持 MySQL, Percona, MariaDB

jdcloud_sdk.services.rds.apis.DescribeDatabasesRequest module

class jdcloud_sdk.services.rds.apis.DescribeDatabasesRequest.DescribeDatabasesParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setDbName(dbName)[source]
Parameters:dbName – (Optional) 数据库名。如果不指定数据库名,则返回所有数据库列表<br>- MySQL:不支持该字段**<br>- **SQL Server:支持该字段
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为100,取值范围:[10,100],用于查询列表的接口
class jdcloud_sdk.services.rds.apis.DescribeDatabasesRequest.DescribeDatabasesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取当前实例的所有数据库详细信息的列表

jdcloud_sdk.services.rds.apis.DescribeErrorLogsRequest module

class jdcloud_sdk.services.rds.apis.DescribeErrorLogsRequest.DescribeErrorLogsParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeErrorLogsRequest.DescribeErrorLogsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取SQL Server 错误日志及下载信息<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeImportFilesRequest module

class jdcloud_sdk.services.rds.apis.DescribeImportFilesRequest.DescribeImportFilesParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeImportFilesRequest.DescribeImportFilesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取用户通过单库上云工具上传到该实例上的文件列表<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeIndexPerformanceRequest module

class jdcloud_sdk.services.rds.apis.DescribeIndexPerformanceRequest.DescribeIndexPerformanceParameters(regionId, instanceId, queryType)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • queryType – 查询类型,不同的查询类型按照相应的字段从高到低返回结果。<br>支持如下类型:<br>Missing:缺失索引<br>Size:索引大小,单位KB<br>Updates:索引更新次数<br>Scans:表扫描次数<br>Used:最少使用<br>
setDb(db)[source]
Parameters:db – (Optional) 需要查询的数据库名,多个数据库名之间用英文逗号分隔,默认所有数据库
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞]。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为50,取值范围:[1,100],只能为10的倍数,用于查询列表的接口
class jdcloud_sdk.services.rds.apis.DescribeIndexPerformanceRequest.DescribeIndexPerformanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据用户定义的查询条件,获取索引性能的统计信息,并提供缺失索引及索引创建建议。用户可以根据这些信息查找与索引相关的性能瓶颈,并进行优化。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeInstanceAttributesRequest module

class jdcloud_sdk.services.rds.apis.DescribeInstanceAttributesRequest.DescribeInstanceAttributesParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setInstanceExistence(instanceExistence)[source]
Parameters:instanceExistence – (Optional) 默认不传,返回当前未删除的实例的实例详情 **仅支持 MySQL,Percona,MariaDB。<br>请求参数:<br>- 0:当前存在的实例;<br>- 1:已删除的实例;<br>- 2:全部实例,不区分实例是否删除;
class jdcloud_sdk.services.rds.apis.DescribeInstanceAttributesRequest.DescribeInstanceAttributesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询RDS实例(MySQL、SQL Server等)的详细信息以及MySQL/PostgreSQL只读实例详细信息

jdcloud_sdk.services.rds.apis.DescribeInstancesRequest module

class jdcloud_sdk.services.rds.apis.DescribeInstancesRequest.DescribeInstancesParameters(regionId)[source]

Bases: object

Parameters:regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and)

支持以下属性的过滤: instanceId, 支持operator选项:eq instanceName, 支持operator选项:eq, like engine, 支持operator选项:eq engineVersion, 支持operator选项:eq instanceStatus, 支持operator选项:eq vpcId, 支持operator选项:eq instanceType, 支持operator选项:eq internalDomainName, 支持operator选项:eq publicDomainName, 支持operator选项:eq roInstanceProxyInternalDomainName, 支持operator选项:like readWriteProxyInternalDomainName, 支持operator选项:like

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞]。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100],且为10的整数倍
setResourceGroupIds(resourceGroupIds)[source]
Parameters:resourceGroupIds – (Optional) 资源组id
setTagFilters(tagFilters)[source]
Parameters:tagFilters – (Optional) 资源标签
class jdcloud_sdk.services.rds.apis.DescribeInstancesRequest.DescribeInstancesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取当前账号下所有RDS实例及MySQL/PostgreSQL只读实例的概要信息,例如实例类型,版本,计费信息等

jdcloud_sdk.services.rds.apis.DescribeInterceptRequest module

class jdcloud_sdk.services.rds.apis.DescribeInterceptRequest.DescribeInterceptParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • instanceId – Instance ID
class jdcloud_sdk.services.rds.apis.DescribeInterceptRequest.DescribeInterceptRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看当前实例已开启的安全模式。如果开启数据库的高安全模式,会返回配置信息<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.DescribeInterceptResultRequest module

class jdcloud_sdk.services.rds.apis.DescribeInterceptResultRequest.DescribeInterceptResultParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • instanceId – Instance ID
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and);

支持以下属性的过滤:account,database,keyword; 支持operator选项:eq,in; 仅支持 MySQL,Percona,MariaDB

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100],且为10的整数倍
class jdcloud_sdk.services.rds.apis.DescribeInterceptResultRequest.DescribeInterceptResultRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看开启高安全模式后,当前实例的 SQL 拦截记录<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.DescribeLatestRestoreTimeRequest module

class jdcloud_sdk.services.rds.apis.DescribeLatestRestoreTimeRequest.DescribeLatestRestoreTimeParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeLatestRestoreTimeRequest.DescribeLatestRestoreTimeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取SQL Server实例按时间点恢复/创建时,可恢复到的最后的一个时间点<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeParameterGroupAttachedInstancesRequest module

class jdcloud_sdk.services.rds.apis.DescribeParameterGroupAttachedInstancesRequest.DescribeParameterGroupAttachedInstancesParameters(regionId, parameterGroupId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – Parameter Group ID
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100],且为10的整数倍
class jdcloud_sdk.services.rds.apis.DescribeParameterGroupAttachedInstancesRequest.DescribeParameterGroupAttachedInstancesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看参数组绑定的云数据库实例<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.DescribeParameterGroupParametersRequest module

class jdcloud_sdk.services.rds.apis.DescribeParameterGroupParametersRequest.DescribeParameterGroupParametersParameters(regionId, parameterGroupId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – Parameter Group ID
class jdcloud_sdk.services.rds.apis.DescribeParameterGroupParametersRequest.DescribeParameterGroupParametersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看参数组的参数<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.DescribeParameterGroupsRequest module

class jdcloud_sdk.services.rds.apis.DescribeParameterGroupsRequest.DescribeParameterGroupsParameters(regionId)[source]

Bases: object

Parameters:regionId – Region ID
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100],且为10的整数倍
class jdcloud_sdk.services.rds.apis.DescribeParameterGroupsRequest.DescribeParameterGroupsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取当前账号下所有的参数组列表<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.DescribeParameterModifyRecordsRequest module

class jdcloud_sdk.services.rds.apis.DescribeParameterModifyRecordsRequest.DescribeParameterModifyRecordsParameters(regionId, parameterGroupId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – Parameter Group ID
setEndTime(endTime)[source]
Parameters:endTime – (Optional) 查询结束时间,格式为:YYYY-MM-DD HH:mm:ss
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞)。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100],且为10的整数倍
setStartTime(startTime)[source]
Parameters:startTime – (Optional) 查询开始时间,格式为:YYYY-MM-DD HH:mm:ss
class jdcloud_sdk.services.rds.apis.DescribeParameterModifyRecordsRequest.DescribeParameterModifyRecordsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看参数的修改历史<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.DescribeParametersRequest module

class jdcloud_sdk.services.rds.apis.DescribeParametersRequest.DescribeParametersParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • instanceId – Instance ID
class jdcloud_sdk.services.rds.apis.DescribeParametersRequest.DescribeParametersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看SQL Server实例的配置参数<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeQueryPerformanceRequest module

class jdcloud_sdk.services.rds.apis.DescribeQueryPerformanceRequest.DescribeQueryPerformanceParameters(regionId, instanceId, queryType)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • queryType – 查询类型,不同的查询类型按照相应的字段从高到低返回结果。<br>支持如下类型:<br>ExecutionCount:执行次数<br>LastRows:上次返回行数<br>ElapsedTime:平均执行时间<br>CPUTime:平均CPU时间<br>LogicalReads:平均逻辑读<br>LogicalWrites:平均逻辑写<br>PhysicalReads:平均物理读<br>
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,1000]。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为50,取值范围:[1,100],只能为10的倍数,用于查询列表的接口
setThreshold(threshold)[source]
Parameters:threshold – (Optional) 只返回查询条件大于等于threshold的记录,默认为0
class jdcloud_sdk.services.rds.apis.DescribeQueryPerformanceRequest.DescribeQueryPerformanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

根据用户定义的查询条件,获取SQL执行的性能统计信息,例如慢SQL等。用户可以根据这些信息查找与SQL执行相关的性能瓶颈,并进行优化。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.DescribeSlowLogAttributesRequest module

class jdcloud_sdk.services.rds.apis.DescribeSlowLogAttributesRequest.DescribeSlowLogAttributesParameters(regionId, instanceId, startTime, endTime)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • startTime – 慢日志开始时间,格式为:YYYY-MM-DD HH:mm:ss,开始时间到当前时间不能大于 7 天, 开始时间不能大于结束时间
  • endTime – 慢日志结束时间,格式为:YYYY-MM-DD HH:mm:ss,开始时间到当前时间不能大于 7 天, 开始时间不能大于结束时间
setDbName(dbName)[source]
Parameters:dbName – (Optional) 废弃字段,查询哪个数据库的慢日志,不填表示返回所有数据库的慢日志。
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and支持以下属性的过滤(默认等值):)
  • account:实例账号名,operator仅支持eq或者in
  • keyword:SQL 关键词,模糊查询,operator仅支持eq或者in
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞]。pageNumber为-1时,返回所有数据页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100]
setSorts(sorts)[source]
Parameters:sorts – (Optional) 慢日志明细的排序规则,不指定时按上报日志的时间戳降序返回所有的日志
class jdcloud_sdk.services.rds.apis.DescribeSlowLogAttributesRequest.DescribeSlowLogAttributesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询MySQL实例的慢日志的详细信息。<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.DescribeSlowLogsRequest module

class jdcloud_sdk.services.rds.apis.DescribeSlowLogsRequest.DescribeSlowLogsParameters(regionId, instanceId, startTime, endTime)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • startTime – 慢日志开始时间,格式为:YYYY-MM-DD HH:mm:ss,开始时间到当前时间不能大于 7 天,开始时间不能大于结束时间
  • endTime – 慢日志结束时间,格式为:YYYY-MM-DD HH:mm:ss,开始时间到当前时间不能大于 7 天,开始时间不能大于结束时间
setDbName(dbName)[source]
Parameters:dbName – (Optional) 废弃字段,查询哪个数据库的慢日志,不填表示返回所有数据库的慢日志
setFilters(filters)[source]
param filters:(Optional) 过滤参数,多个过滤参数之间的关系为“与”(and支持以下属性的过滤(默认等值):)
  • account:实例账号名,operator仅支持eq或者in
  • keyword:SQL 关键词,模糊查询,operator仅支持eq或者in
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 显示数据的页码,默认为1,取值范围:[-1,∞]。pageNumber为-1时,返回所有数据页码;
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 每页显示的数据条数,默认为10,取值范围:[10,100]
setSorts(sorts)[source]
Parameters:sorts – (Optional) 排序参数,支持rowsExaminedSum、rowsSentSum、lockTimeSum、executionCount、executionTimeSum
class jdcloud_sdk.services.rds.apis.DescribeSlowLogsRequest.DescribeSlowLogsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询MySQL实例的慢日志的概要信息。<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.DescribeWhiteListRequest module

class jdcloud_sdk.services.rds.apis.DescribeWhiteListRequest.DescribeWhiteListParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DescribeWhiteListRequest.DescribeWhiteListRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看RDS实例当前白名单。白名单是允许访问当前实例的IP/IP段列表,缺省情况下,白名单对本VPC开放。如果用户开启了外网访问的功能,还需要对外网的IP配置白名单。

jdcloud_sdk.services.rds.apis.DisableAuditRequest module

class jdcloud_sdk.services.rds.apis.DisableAuditRequest.DisableAuditParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DisableAuditRequest.DisableAuditRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

仅支持MySQL实例关闭数据库审计<br>- 仅支持 MySQL 5.6, MySQL 5.7, Percona, MariaDB, PostgreSQL

jdcloud_sdk.services.rds.apis.DisableInterceptRequest module

class jdcloud_sdk.services.rds.apis.DisableInterceptRequest.DisableInterceptParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • instanceId – Instance ID
class jdcloud_sdk.services.rds.apis.DisableInterceptRequest.DisableInterceptRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

关闭数据库的高安全模式<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.DisableInternetAccessRequest module

class jdcloud_sdk.services.rds.apis.DisableInternetAccessRequest.DisableInternetAccessParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.DisableInternetAccessRequest.DisableInternetAccessRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

关闭RDS实例的外网访问功能。关闭后,用户无法通过Internet访问RDS,但可以在京东云内网通过内网域名访问

jdcloud_sdk.services.rds.apis.EnableAuditRequest module

class jdcloud_sdk.services.rds.apis.EnableAuditRequest.EnableAuditParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.EnableAuditRequest.EnableAuditRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

仅支持MySQL实例开启数据库审计<br>- 仅支持 MySQL 5.6, MySQL 5.7, Percona, MariaDB, PostgreSQL

jdcloud_sdk.services.rds.apis.EnableInterceptRequest module

class jdcloud_sdk.services.rds.apis.EnableInterceptRequest.EnableInterceptParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • instanceId – Instance ID
class jdcloud_sdk.services.rds.apis.EnableInterceptRequest.EnableInterceptRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

开启数据库的高安全模式<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.EnableInternetAccessRequest module

class jdcloud_sdk.services.rds.apis.EnableInternetAccessRequest.EnableInternetAccessParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.EnableInternetAccessRequest.EnableInternetAccessRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

开启RDS实例的外网访问功能。开启后,用户可以通过internet访问RDS实例

jdcloud_sdk.services.rds.apis.ExchangeInstanceDnsRequest module

class jdcloud_sdk.services.rds.apis.ExchangeInstanceDnsRequest.ExchangeInstanceDnsParameters(regionId, instanceId, targetInstanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • targetInstanceId – 要交换的实例ID
class jdcloud_sdk.services.rds.apis.ExchangeInstanceDnsRequest.ExchangeInstanceDnsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

交换两个实例的域名,包括内网域名和外网域名。如果一个实例有外网域名,一个没有,则不允许交换。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.FailoverInstanceRequest module

class jdcloud_sdk.services.rds.apis.FailoverInstanceRequest.FailoverInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.FailoverInstanceRequest.FailoverInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

对RDS实例进行主备切换。<br>注意:如果实例正在进行备份,那么主备切换将会终止备份操作。可以查看备份策略中的备份开始时间确认是否有备份正在运行。如果确实需要在实例备份时进行主备切换,建议切换完成 后,手工进行一次实例的全备<br>对于SQL Server,主备切换后30分钟内,不支持按时间点恢复/创建,例如在10:05分用户进行了主备切换,那么10:05 ~ 10:35这个时间段不能进行按时间点恢复/创建。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.GetUploadKeyRequest module

class jdcloud_sdk.services.rds.apis.GetUploadKeyRequest.GetUploadKeyParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
class jdcloud_sdk.services.rds.apis.GetUploadKeyRequest.GetUploadKeyRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

获取单库上云工具上传文件的需要的Key。单库上云工具需要正确的key值方能连接到京东云<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.GrantPrivilegeRequest module

class jdcloud_sdk.services.rds.apis.GrantPrivilegeRequest.GrantPrivilegeParameters(regionId, instanceId, accountName, accountPrivileges)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • accountName – 账号名,在同一个实例中账号名不能重复
  • accountPrivileges – 账号的访问权限
class jdcloud_sdk.services.rds.apis.GrantPrivilegeRequest.GrantPrivilegeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

授予账号的数据库访问权限,即该账号对数据库拥有什么权限。一个账号可以对多个数据库具有访问权限。<br>为便于管理,RDS对权限进行了归类,目前提供以下两种权限<br>- ro:只读权限,用户只能读取数据库中的数据,不能进行创建、插入、删除、更改等操作。<br>- rw:读写权限,用户可以对数据库进行增删改查等操作

jdcloud_sdk.services.rds.apis.ModifyAuditRequest module

class jdcloud_sdk.services.rds.apis.ModifyAuditRequest.ModifyAuditParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setAdd(add)[source]
Parameters:add – (Optional) 在原有审计项基础上,增加新的审计项,多个审计项之间用英文逗号,分号或空格分隔,例如DATABASE_OBJECT_ACCESS_GROUP,ACKUP_RESTORE_GROUP
setDrop(drop)[source]
Parameters:drop – (Optional) 删除审计项,多个审计项之间用英文逗号,分号或空格分隔,例如DATABASE_OBJECT_ACCESS_GROUP,ACKUP_RESTORE_GROUP<br>如删除了所有审计项,则审计自动关闭
class jdcloud_sdk.services.rds.apis.ModifyAuditRequest.ModifyAuditRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改当前的审计选项。当前已有审计选项可以通过describeAudit获得,支持的全部选项可以通过getAuditOptions获得。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.ModifyBackupPolicyRequest module

class jdcloud_sdk.services.rds.apis.ModifyBackupPolicyRequest.ModifyBackupPolicyParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setBackupPeriod(backupPeriod)[source]
Parameters:backupPeriod – (Optional) 备份周期。至少需要指定2天,取值:<br>• Monday:周一<br>• Tuesday:周二<br>• Wednesday:周三<br>• Thursday:周四<br>• Friday:周五<br>• Saturday:周六<br>• Sunday:周日
setBinlogRetentionNumber(binlogRetentionNumber)[source]
Parameters:binlogRetentionNumber – (Optional) 本地binlog最大保留数量,支持设置保留个数为6-1000个,可传-1表示不限保留个数,默认为-1。
setBinlogRetentionPeriod(binlogRetentionPeriod)[source]
Parameters:binlogRetentionPeriod – (Optional) binlog本地保留周期,单位小时,范围1-168,默认为24
setBinlogSpaceProtection(binlogSpaceProtection)[source]
Parameters:binlogSpaceProtection – (Optional) 设置空间保护,开启:on,关闭:off;开启后,磁盘剩余空间小于20%或剩余空间不足5GB时,将自动清理本地binlog。 <br>- 仅支持MySQL
setBinlogUsageLimit(binlogUsageLimit)[source]
Parameters:binlogUsageLimit – (Optional) binlog本地占用空间上限,单位%,范围5-50,默认为30
setCycleMode(cycleMode)[source]
Parameters:cycleMode – (Optional) 自动备份循环模式<br>1:表示每天都是全量备份<br>2:表示自动备份按照全量、增量、增量这样的方式进行,例如第1天是全量备份,第2、3天是增量备份;第4天又是全量备份,以此类推<br>当enhancedBackup为true时可修改<br>- 仅支持SQL Server
setReleasedKeepPolicy(releasedKeepPolicy)[source]
Parameters:releasedKeepPolicy – (Optional) 已删除实例的备份保留策略,取值:<br>• CreateAndKeep:删除时新创建备份并保留<br>• All:全部保留<br>• None:不保留
setRetentionPeriod(retentionPeriod)[source]
Parameters:retentionPeriod – (Optional) 自动备份保留周期,单位天,范围7-730<br>SQL Server需要当enhancedBackup为true时才可修改
setStartWindow(startWindow)[source]
Parameters:startWindow – (Optional) 自动备份开始时间窗口,例如:00:00-01:00,表示0点到1点开始进行数据库自动备份,备份完成时间则跟实例大小有关,不一定在这个时间范围中<br>SQL Server:范围00:00-23:59,时间范围差不得小于30分钟。<br>MySQL,只能是以下取值:<br>00:00-01:00<br>01:00-02:00<br>……<br>23:00-24:00
class jdcloud_sdk.services.rds.apis.ModifyBackupPolicyRequest.ModifyBackupPolicyRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改RDS实例备份策略,目前仅支持用户修改“自动备份开始时间窗口”这个参数,其他参数暂不开放修改

jdcloud_sdk.services.rds.apis.ModifyConnectionModeRequest module

class jdcloud_sdk.services.rds.apis.ModifyConnectionModeRequest.ModifyConnectionModeParameters(regionId, instanceId, connectionMode)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • connectionMode – 连接模式<br> - standard:标准模式(缺省),响应时间短,但没有 SQL 审计和拦截的能力 <br>- security:高安全模式,具备一定的 SQL注入拦截能力,并可开启 SQL 审计,但会增加一定的响应时间
class jdcloud_sdk.services.rds.apis.ModifyConnectionModeRequest.ModifyConnectionModeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改MySQL实例的连接模式:标准模式(standard) 和高安全模式(security).<br>- 标准模式:响应时间短,但没有 SQL 审计和拦截的能力。<br>- 高安全模式:具备一定的 SQL注入拦截能力(通过分析表达式、关键系统函数等来实现防御 SQL 注入攻击),并可开启 SQL 审计,但会增加一定的响应时间。<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.ModifyInstanceNameRequest module

class jdcloud_sdk.services.rds.apis.ModifyInstanceNameRequest.ModifyInstanceNameParameters(regionId, instanceId, instanceName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • instanceName – 实例名称,名称支持中文,实例名的具体规则可参见帮助中心文档:[名称及密码限制](../../../documentation/Database-and-Cache-Service/RDS/Introduction/Restrictions/SQLServer-Restrictions.md)
class jdcloud_sdk.services.rds.apis.ModifyInstanceNameRequest.ModifyInstanceNameRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改实例名称,可支持中文,实例名的具体规则可参见帮助中心文档:[名称及密码限制](../../../documentation/Database-and-Cache-Service/RDS/Introduction/Restrictions/SQLServer-Restrictions.md)

jdcloud_sdk.services.rds.apis.ModifyInstanceSpecRequest module

class jdcloud_sdk.services.rds.apis.ModifyInstanceSpecRequest.ModifyInstanceSpecParameters(regionId, instanceId, newInstanceClass, newInstanceStorageGB)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • newInstanceClass – 扩容后实例规格
  • newInstanceStorageGB – 扩容后实例磁盘大小
setEffectiveTime(effectiveTime)[source]
Parameters:effectiveTime – (Optional) 生效时间,取值:<br>immediate:立即生效<br>maintainTime:在可维护时间段内生效。<br>postpone:延后生效。
setNewInstanceStorageType(newInstanceStorageType)[source]
Parameters:newInstanceStorageType – (Optional) 存储类型,如果不指定,默认会采用实例原存储类型.
setPostponeTime(postponeTime)[source]
Parameters:postponeTime – (Optional) 延后生效的时间,单位为分钟。effectiveTime为postpone时必传,取值1-1440分钟
setStorageEncrypted(storageEncrypted)[source]
Parameters:storageEncrypted – (Optional) 实例数据加密(存储类型为云硬盘才支持数据加密). false:不加密; true:加密. 如果实例从本地盘变为云硬盘,缺省为false. 如果实例本来就是使用云硬盘的,缺省和源实例保持一致
setSubnetId(subnetId)[source]
Parameters:subnetId – (Optional) 变配后的子网ID
class jdcloud_sdk.services.rds.apis.ModifyInstanceSpecRequest.ModifyInstanceSpecRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

实例扩容,支持升级实例的CPU,内存及磁盘。

jdcloud_sdk.services.rds.apis.ModifyParameterGroupAttributeRequest module

class jdcloud_sdk.services.rds.apis.ModifyParameterGroupAttributeRequest.ModifyParameterGroupAttributeParameters(regionId, parameterGroupId, parameterGroupName)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – Parameter Group ID
  • parameterGroupName – 参数组名称
setDescription(description)[source]
Parameters:description – (Optional) 参数组描述
class jdcloud_sdk.services.rds.apis.ModifyParameterGroupAttributeRequest.ModifyParameterGroupAttributeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改参数组名称,描述<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.ModifyParameterGroupParametersRequest module

class jdcloud_sdk.services.rds.apis.ModifyParameterGroupParametersRequest.ModifyParameterGroupParametersParameters(regionId, parameterGroupId, parameters)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • parameterGroupId – Parameter Group ID
  • parameters – 修改的参数
class jdcloud_sdk.services.rds.apis.ModifyParameterGroupParametersRequest.ModifyParameterGroupParametersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改参数组的参数<br>- 仅支持MySQL,Percona,MariaDB,PostgreSQL

jdcloud_sdk.services.rds.apis.ModifyParameterGroupRequest module

class jdcloud_sdk.services.rds.apis.ModifyParameterGroupRequest.ModifyParameterGroupParameters(regionId, instanceId, parameterGroupId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • parameterGroupId – 参数组ID
class jdcloud_sdk.services.rds.apis.ModifyParameterGroupRequest.ModifyParameterGroupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改RDS实例的参数组<br>- 仅支持MySQL

jdcloud_sdk.services.rds.apis.ModifyParametersRequest module

class jdcloud_sdk.services.rds.apis.ModifyParametersRequest.ModifyParametersParameters(regionId, instanceId, parameters)[source]

Bases: object

Parameters:
  • regionId – Region ID
  • instanceId – Instance ID
  • parameters – 修改的实例参数
class jdcloud_sdk.services.rds.apis.ModifyParametersRequest.ModifyParametersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改SQL Server实例的配置参数,目前支持以下参数:max_worker_threads,max_degree_of_parallelism,max_server_memory_(MB)。 部分参数修改后,需要重启才能生效,具体可以参考微软的相关文档。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.ModifyWhiteListRequest module

class jdcloud_sdk.services.rds.apis.ModifyWhiteListRequest.ModifyWhiteListParameters(regionId, instanceId, ips)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • ips – IP或IP段,不同的IP/IP段之间用英文逗号分隔,例如0.0.0.0/0,192.168.0.10
setWhiteListName(whiteListName)[source]
Parameters:whiteListName – (Optional) 白名单名称,默认Default
class jdcloud_sdk.services.rds.apis.ModifyWhiteListRequest.ModifyWhiteListRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

修改允许访问实例的IP白名单。白名单是允许访问当前实例的IP/IP段列表,缺省情况下,白名单对本VPC开放。如果用户开启了外网访问的功能,还需要对外网的IP配置白名单。

jdcloud_sdk.services.rds.apis.RebootInstanceRequest module

class jdcloud_sdk.services.rds.apis.RebootInstanceRequest.RebootInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setForce(force)[source]
Parameters:force – (Optional) 是否强制重启 <br>- 仅支持MySQL
setRebootMaster(rebootMaster)[source]
Parameters:rebootMaster – (Optional) 是否重启主节点。<br> - 仅SQL Server 支持该参数
setRebootSlave(rebootSlave)[source]
Parameters:rebootSlave – (Optional) 是否重启备节点。<br> - 仅SQL Server 支持该参数
class jdcloud_sdk.services.rds.apis.RebootInstanceRequest.RebootInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

重启RDS实例,例如修改了一些配置参数后,需要重启实例才能生效。可以结合主备切换的功能,轮流重启备机,降低对业务的影响<br>**注意:如果实例正在进行备份,那么重启主实例将会终止备份操作。** 可以查看备份策略中的备份开始时间确认是否有备份正在运行。如果确实需要在实例备份时重启主实例,建议重启后,手工进行一次实例的全备。

jdcloud_sdk.services.rds.apis.ResetPasswordRequest module

class jdcloud_sdk.services.rds.apis.ResetPasswordRequest.ResetPasswordParameters(regionId, instanceId, accountName, accountPassword)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • accountName – 账号名,在同一个实例中账号名不能重复
  • accountPassword – 新密码,密码的具体规则可参见帮助中心文档:[名称及密码限制](../../../documentation/Database-and-Cache-Service/RDS/Introduction/Restrictions/SQLServer-Restrictions.md)
class jdcloud_sdk.services.rds.apis.ResetPasswordRequest.ResetPasswordRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

重置数据库账号密码。如果用户忘记账号的密码,可以使用该接口重置指定账号密码。密码重置后,以前的密码将无法使用,必须使用重置后的新密码登录或连接数据库实例。

jdcloud_sdk.services.rds.apis.RestoreDatabaseFromBackupRequest module

class jdcloud_sdk.services.rds.apis.RestoreDatabaseFromBackupRequest.RestoreDatabaseFromBackupParameters(regionId, instanceId, dbName, backupId, backupFileName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • dbName – 库名称
  • backupId – 备份ID,可从备份查询接口describeBackups获取
  • backupFileName – 指定该备份中用于恢复数据库的文件名称。通常情况下文件名(不包括后缀)即为备份的数据库名。例如文件名为my_test_db.bak,表示该文件是my_test_db数据库的备份
class jdcloud_sdk.services.rds.apis.RestoreDatabaseFromBackupRequest.RestoreDatabaseFromBackupRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

从备份中恢复单个数据库,支持从其他实例(但必须是同一个账号下的实例)备份中恢复。例如可以从生产环境的数据库实例的备份恢复到测试环境的数据库中。<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.RestoreDatabaseFromFileRequest module

class jdcloud_sdk.services.rds.apis.RestoreDatabaseFromFileRequest.RestoreDatabaseFromFileParameters(regionId, instanceId, dbName, fileName)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • dbName – 库名称
  • fileName – 用户上传的备份文件名称(包括文件后缀名),例如mydb1.bak
setSharedFileGid(sharedFileGid)[source]
Parameters:sharedFileGid – (Optional) 共享文件的全局ID,可从上传文件查询接口[describeImportFiles](../Cloud-on-Single-Database/describeImportFiles.md)获取;如果该文件不是共享文件,则不用输入该参数
class jdcloud_sdk.services.rds.apis.RestoreDatabaseFromFileRequest.RestoreDatabaseFromFileRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

从用户通过单库上云工具上传到云上的备份文件中恢复单个数据库<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.RestoreDatabaseFromOSSRequest module

class jdcloud_sdk.services.rds.apis.RestoreDatabaseFromOSSRequest.RestoreDatabaseFromOSSParameters(regionId, instanceId, dbName, ossURL)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • dbName – 库名称
  • ossURL – 用户上传到对象存储OSS上的备份文件的路径。<br>例如用户备份上传的bucket为db_backup,文件为test_server/db1.bak,那么ossULR为db_backup/test_server/db1.bak。<br>**授权说明**:需要授予账户ID:785455908940,对这个bucket的读取权限,具体步骤可以查看[文档](https://docs.jdcloud.com/cn/object-storage-service/set-bucket-policy-2)。
class jdcloud_sdk.services.rds.apis.RestoreDatabaseFromOSSRequest.RestoreDatabaseFromOSSRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

从上传到OSS的备份文件中恢复单个数据库<br>- 仅支持SQL Server

jdcloud_sdk.services.rds.apis.RestoreInstanceRequest module

class jdcloud_sdk.services.rds.apis.RestoreInstanceRequest.RestoreInstanceParameters(regionId, instanceId)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
setBackupId(backupId)[source]
Parameters:backupId – (Optional) 用于恢复的备份Id,仅限于本实例生成的备份
class jdcloud_sdk.services.rds.apis.RestoreInstanceRequest.RestoreInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

使用实例的全量备份覆盖恢复当前实例

jdcloud_sdk.services.rds.apis.RevokePrivilegeRequest module

class jdcloud_sdk.services.rds.apis.RevokePrivilegeRequest.RevokePrivilegeParameters(regionId, instanceId, accountName, dbNames)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • accountName – 账号名,在同一个实例中账号名不能重复
  • dbNames – 需要取消授权的数据库的名称。权限取消后,该账号将不能访问此数据库
class jdcloud_sdk.services.rds.apis.RevokePrivilegeRequest.RevokePrivilegeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

取消该账号对某个数据库的所有权限。权限取消后,该账号将不能访问此数据库。取消账号对某个数据库的访问权限,不影响该账号对其他数据库的访问权限

jdcloud_sdk.services.rds.apis.SetImportFileSharedRequest module

class jdcloud_sdk.services.rds.apis.SetImportFileSharedRequest.SetImportFileSharedParameters(regionId, instanceId, fileName, shared)[source]

Bases: object

Parameters:
  • regionId – 地域代码,取值范围参见[《各地域及可用区对照表》](../Enum-Definitions/Regions-AZ.md)
  • instanceId – RDS 实例ID,唯一标识一个RDS实例
  • fileName – 单库上云文件名
  • shared – 文件是否共享<br>true:共享<br>false:不共享
class jdcloud_sdk.services.rds.apis.SetImportFileSharedRequest.SetImportFileSharedRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

设置或取消上传文件是否共享给同一账号下的其他实例。缺省情况下,文件仅在上传的实例上可见并可导入,其他实例不可见不可导入。如果需要该文件在其他实例上也可导入,可将此文件设置为共享<br>- 仅支持SQL Server

Module contents