云数据库RDS

    对象说明

    Instance Object详情

    参数名称 类型 描述
    instanceId String 实例ID
    instanceName String 数据库实例名
    engine String 数据库引擎,参见引擎类型
    engineVersion String 数据库引擎版本,取值参考数据库版本
    category String 所属系列。Basic:单机基础版,Standard:双机高可用版。
    instanceStatus String 实例状态,参见实例状态表
    cpuCount Int CPU核数
    memoryCapacity Int 实例内存,单位GB
    volumeCapacity Int 存储空间,单位GB
    nodeAmount Int 节点数(代理实例)
    usedStorage Int 已用存储空间,单位GB
    publicAccessStatus String 外网访问功能状态,参考公网状态表
    instanceCreateTime Datetime 实例创建时间,规范参考时间与日期
    instanceExpireTime Datetime 实例到期时间,规范参考时间与日期
    instanceType String 实例类型,参考实例类型
    sourceInstanceId String 主实例id,如果为主实例则为空
    zoneNames List String 实例的可用区
    paymentTiming String 付费方式,参考付费方式

    InstanceDescribe Object详情

    参数名称 类型 描述
    instanceId String 实例ID
    instanceName String 数据库实例名
    engine String 数据库引擎,参见引擎类型
    engineVersion String 数据库引擎版本,取值参考数据库版本
    category String 所属系列。Basic:单机基础版,Standard:双机高可用版。
    instanceStatus String 实例状态,参见实例状态表
    cpuCount Int CPU核数
    memoryCapacity Int 实例内存,单位GB
    volumeCapacity Int 存储空间,单位GB
    nodeAmount Int 节点数(代理实例)
    usedStorage Int 已用存储空间,单位GB
    instanceCreateTime Datetime 实例创建时间,规范参考时间与日期
    instanceExpireTime Datetime 实例到期时间,规范参考时间与日期
    endpoint Endpoint 数据库连接信息,Endpoint Object
    publicAccessStatus String 外网访问功能状态,参考公网状态表
    syncMode String 数据同步模式所处状态,参考同步模式
    backupPolicy BackupPolicy 备份策略, BackupPolicy Object
    region String 该实例的区域。
    instanceType String 实例类型,参考实例类型
    sourceInstanceId String 主实例id,如果为主实例则为空
    zoneName String 实例的逻辑可用区
    vpcId String 实例所属VPC的ID
    subnets List Subnet 实例所在子网,Subnet Object
    topology Topology 实例所属数据库集群的拓扑信息,Topology Object
    paymentTiming String 付费方式,参考付费方式

    Subnet Object详情

    参数名称 参数类型 参数描述
    name String 子网名
    subnetId String 子网Id
    zoneName String 子网所在可用区
    cidr String 子网cidr
    vpcId String 所属vpc的id

    Endpoint Object详情

    参数名称 参数类型 参数描述
    address String 数据库连接地址
    port Int 数据库端口
    vnetIp String 数据库连接的IP(因为主从切换而变化)
    inetIp String 从公网连接数据库的IP(不会因为主从切换而变化)

    BackupPolicy Object详情

    参数名称 参数类型 参数描述
    backupDays String 以英文半角逗号分隔的备份时日间,周日为第一天,取值0
    举例:"0,1,2,3,5,6"
    backupTime String 备份开始时间,使用UTC时间
    举例:"17:00:00Z"
    persistent Boolean 是否启用了备份数据持久化
    expireInDays Int 持久化天数,未启用则为0
    freeSpaceInGB Int 免费赠送的存储空间大小,单位为GB

    Topology Object详情

    参数名称 参数类型 参数描述
    rdsproxy List<String> 集群内代理实例ID列表
    master List<String> 集群内主实例ID列表(只有一个)
    readReplica List<String> 集群内只读副本实例ID列表

    Database Object详情

    参数名称 参数类型 参数描述
    dbName String 数据库名称
    characterSetName String 字符集。参考MySQL字符集SQL Server字符集
    dbStatus String 数据库状态.参考数据库状态表
    remark String 数据库备注信息
    accountPrivileges List AccountPrivilege 关联的账号列表及权限

    AccountPrivilege Object详情

    参数名称 参数类型 参数描述
    accountName String 数据库名称
    authType String 授权类型。ReadOnly:只读,ReadWrite:读写。
    详情参考

    Account Object详情

    参数名称 参数类型 参数描述
    accountName String 账号名称
    remark String 账号备注信息
    status String 账号状态信息,参考账号状态
    type String 账号归属类型。
    OnlyMaster:在主实例上使用的账号,
    RdsProxy:在中间件上使用的账号。详情参考账号归属类型表
    accountType String 账号权限类型。Super:高权限账号,Common:普通帐号。详情参考账号权限类型表
    databasePrivileges List DatabasePrivilege DatabasePrivilege组成的数组

    DatabasePrivilege Object详情

    参数名称 参数类型 参数描述
    dbName String 数据库名称
    authType String 授权类型。ReadOnly:只读,ReadWrite:读写。
    详情参考

    Backup Object

    参数名称 参数类型 参数描述
    backupId String 备份标识
    backupSize int 备份大小,单位MB
    backupType String 手动/自动,参考备份类型
    backupStatus String 备份状态,参考备份状态
    backupStartTime String 备份开始时间
    backupEndTime String 备份结束时间

    Backup Object详情

    参数名称 参数类型 参数描述
    backupId String 备份标识
    backupSize int 备份大小,单位MB
    backupType String 手动/自动,参考备份类型
    backupStatus String 备份状态,参考备份状态
    backupStartTime String 备份开始时间
    backupEndTime String 备份结束时间
    downloadExpires String 下载链接有效时间

    Log Object详情

    参数名称 参数类型 参数描述
    logType String 日志类型,参考日志类型
    logId String 日志标识
    logSizeInBytes int 日志文件大小
    logStatus String 日志状态,参考日志状态
    logStartTime String 日志开始时间
    logEndTime String 日志结束时间
    downloadExpires String 下载链接有效时间

    Parameter Object详情

    参数名称 参数类型 参数描述
    name String 参数名称
    defaultValue String 参数默认值
    value String 参数当前值
    pendingValue String 待重启后生效的值
    type String 参数数据类型
    dynamic bool 是否修改后立刻生效
    modifiable bool 是否允许被修改
    allowedValues String 允许的值,默认是用逗号分隔的字符串,表示所有可取值。对于integer类型的,用from-to的形式表示范围。
    desc String 参数描述

    Modify parameter Object详情

    参数名称 参数类型 参数描述
    name String 参数名称
    value String 要修改的值
    上一篇
    其它
    下一篇
    附录