查询RDS实例

接口方法：GET

url 参数

参数名称说明参数类型是否必填备注
InstanceName实例名称列表，如传递该参数，则尝试对列表中每个字符串分别使用模糊匹配（%InstanceName%）的方式来查找实例并汇总，否则，查找用户的所有实例信息，在http调用时以逗号隔开的方式传递多个实例名称string否
Offset偏移条目数，为非正整数，默认为1。long否
Limit当前查询结果最大条目数，为正整数，默认为20long否
InstanceId实例 ID，由系统生成，全局唯一。是访问实例的唯一标识integer否
ExactSearch精确查询标识符，为true时为精确查询（需要InstanceName或InstanceId其中任意一个参数均可，InstanceId优先）boolean否
VpcIdvpcId,在http调用时以逗号隔开的方式传递多个vpcIdstring否
InstanceEndpoint私网IP,在http调用时以逗号隔开的方式传递多个私网IPstring否
SubnetId子网名称,在http调用时以逗号隔开的方式传递多个子网string否
DomainNamedns名称,在http调用时以逗号隔开的方式传递多个dnsstring否
ActionDescribeDBInstancesstring是
Version2018-06-14string是

返回参数

参数名称说明参数类型是否必填备注
Instances实例信息列表array是详细信息见下表
RequestId请求ID，用于追踪后端日志string是
Count符合查询要求的实例个数integer是

Instances

参数名称说明参数类型是否必填备注
InstanceId实例 ID，由系统生成，全局唯一。是访问实例的唯一标识。long否
InstanceName实例名称string否
InstanceStorage存储空间，单位GBlong否
CpuCpu核数long否
Memory内存大小，单位GBlong否
InstanceStatus实例状态string否
EndPoint实例访问地址object否详细信息见下表
Engine数据库引擎string否
EngineVersion数据库引擎版本string否
IsHa是否为高可用版实例，默认为true，表示高可用版实例，为false表示基础版实例。boolean否
IsMgr是否为MGR实例，MGR主要是提供给金融云客户使用的实例。boolean否
NetworkType网络类型string否
CreateAt实例创建时间，ISO8601格式，UTC时间string否
LastestRestorableTime实例最近可恢复时间，ISO8601格式，UTC时间string否
BackupType备份类型string否
FullBackupInterval全量备份周期，单位：天long否
IncreBackupInterval增量备份周期，单位：天long否
BackupRetentionNum备份保留个数long否
PreferredBackupWindow实例自动备份时间窗口string否
DiskMedium硬盘介质string否
ReplicationType复制类型string否
PayType付费类型string否
SecurityGroups安全组array否详细信息见下表
ReadOnlyInstanceNames主实例下挂载的只读实例名称列表。array否
SourceInstanceName若为只读实例，则返回源实例名称，否则为空字符串string否
HealthCheckStatus健康检查状态string否
HealthCheckScore健康检查得分long否
SnapshotCount备份个数long否
DomainName实例的全限定域名，指向内网地址string否
VpcIdVPC IDstring否
SubnetId子网IDstring否
VpcSecurityGroupsVPC安全组ID列表array否
ZoneId实例所属的可用区string否
PoolId实例所在资源池IDstring否
ResourcePoolName实例所在资源池名称string否
IsDec是否为专属资源池实例boolean否
EnablePublicIp是否启用公网 IPboolean否
PublicIp实例公网IP地址string否
PrimaryModeMGR模式，0表示单主，1表示多主integer否
ClusterSizeMGR实例集群大小integer否
IsMultiDC是否为跨机房实例boolean否
ReadWriteDomainName读写DNS地址string否
ReadOnlyDomainName只读DNS地址string否
SecondTopAz第二个TopAZ名称，在multiDC为true的时候有意义string否
MgrVmInfosMGR实例相关VM信息array否详细信息见下表
CloudIops云硬盘IOPSobject否详细信息见下表

CloudIops

参数名称说明参数类型是否必填备注
ReadIops硬盘的读IOPSlong否
WriteIops硬盘的写IOPSlong否
ReadBandwidth硬盘的读带宽long否
WriteBandwidth硬盘的写带宽long否

MgrVmInfos

参数名称说明参数类型是否必填备注
VmIdVM IDinteger否
MemberAlias节点别名，用于监控string否
AvailableZoneVM所在二级AZ名称string否
MemberRole节点角色，取值为PRIMARY/SECONDARYstring否
MemberState节点状态，取值为ONLINE/OFFLINE/ERROR/UNREACHABLE/UNKOWNstring否
MemberHost节点所在的ipstring否
IsBindReadOnlyDomainName该节点是否绑定了只读DNSboolean否
IsBindReadWriteDomainName该节点是否绑定了读写DNSboolean否

SecurityGroups

参数名称说明参数类型是否必填备注
SecurityGroupName安全组名称string否
SecurityGroupDescription安全组描述string否
IpRangesCIDR列表array否

EndPoint

参数名称说明参数类型是否必填备注
Address实例内网 IP 地址string否
Port实例端口号long否

状态码

错误码（Code）错误提示（Message）http status code说明
InvalidParameterValueinvalid parameter value, parameter name: {parameter}400不合法的参数值, 参数名称: {参数}
DBInstanceNotFounddbinstance not found404找不到实例
InternalFailureinternal failure500内部错误

请求示例

https://open.cn-east-1.163yun.com/rds?Action=DescribeDBInstances&Version=2018-06-14&InstanceName=test&Offset=1&Limit=20&<公共请求参数>

返回示例

{
    "RequestId": "abc",
    "Instances": [
        {
            "InstanceId": 9108,
            "ProductID": "3683188b2a614be79466ccaebf202905",
            "InstanceName": "test-lly-0131",
            "InstanceStorage": 20,
            "Cpu": 1,
            "Memory": 2,
            "InstanceStatus": "available",
            "EndPoint": {
                "Address": "10.10.1.191",
                "Port": 3306
            },
            "Engine": "MySQL",
            "EngineVersion": "5.7.20",
            "IsHa": true,
            "IsMgr": false,
            "NetworkType": "private",
            "CreateAt": "2019-01-31T10:26:11Z",
            "LastestRestorableTime": "2019-02-20T11:46:22Z",
            "BackupType": "full",
            "FullBackupInterval": 3,
            "IncreBackupInterval": 1,
            "BackupRetentionNum": 7,
            "PreferredBackupWindow": "19:45-20:15",
            "DiskMedium": "SSD",
            "ReplicationType": "ASYNC",
            "PayType": "AMOUNT",
            "SecurityGroups": [],
            "SourceInstanceName": "",
            "HealthCheckStatus": "normal",
            "HealthCheckScore": 100,
            "SnapshotCount": 9,
            "DomainName": "test-lly-0131-9108.rds.cn-east1.local.",
            "VpcId": "cc63092d-be5f-4efa-81dc-276787b0a077",
            "SubnetId": "7a5dd0a4-01cf-4a8c-b820-f3fa16ca011a",
            "VpcSecurityGroups": [
                "7b0c8a5e-d63c-4c64-b320-91f17b20bc42"
            ],
            "ZoneId": "cn-east-1b",
            "PoolId": "",
            "ResourcePoolName": "",
            "IsDec": false,
            "EnablePublicIp": false,
            "CloudIops": {
                "ReadIops": 2100,
                "WriteIops": 700,
                "ReadBandwidth": 61440,
                "WriteBandwidth": 61440
            }
        }
    ],
    "Count": 1
}