查询 RDS 实例_数据库_产品文档_帮助与文档-网易数帆

产品文档
> 数据库
> RDS
> 开发指南
> API 手册
> 查询 RDS 实例

查询RDS实例

接口方法：GET

url 参数

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

返回参数

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

Instances

参数名称	说明	参数类型	是否必填	备注
InstanceId	实例 ID，由系统生成，全局唯一。是访问实例的唯一标识。	long	否
InstanceName	实例名称	string	否
InstanceStorage	存储空间，单位GB	long	否
Cpu	Cpu核数	long	否
Memory	内存大小，单位GB	long	否
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	否
VpcId	VPC ID	string	否
SubnetId	子网ID	string	否
VpcSecurityGroups	VPC安全组ID列表	array	否
ZoneId	实例所属的可用区	string	否
PoolId	实例所在资源池ID	string	否
ResourcePoolName	实例所在资源池名称	string	否
IsDec	是否为专属资源池实例	boolean	否
EnablePublicIp	是否启用公网 IP	boolean	否
PublicIp	实例公网IP地址	string	否
PrimaryMode	MGR模式，0表示单主，1表示多主	integer	否
ClusterSize	MGR实例集群大小	integer	否
IsMultiDC	是否为跨机房实例	boolean	否
ReadWriteDomainName	读写DNS地址	string	否
ReadOnlyDomainName	只读DNS地址	string	否
SecondTopAz	第二个TopAZ名称，在multiDC为true的时候有意义	string	否
MgrVmInfos	MGR实例相关VM信息	array	否	详细信息见下表
CloudIops	云硬盘IOPS	object	否	详细信息见下表

CloudIops

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

MgrVmInfos

参数名称	说明	参数类型	是否必填
VmId	VM ID	integer	否
MemberAlias	节点别名，用于监控	string	否
AvailableZone	VM所在二级AZ名称	string	否
MemberRole	节点角色，取值为PRIMARY/SECONDARY	string	否
MemberState	节点状态，取值为ONLINE/OFFLINE/ERROR/UNREACHABLE/UNKOWN	string	否
MemberHost	节点所在的ip	string	否
IsBindReadOnlyDomainName	该节点是否绑定了只读DNS	boolean	否
IsBindReadWriteDomainName	该节点是否绑定了读写DNS	boolean	否

SecurityGroups

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

EndPoint

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

状态码

错误码（Code）	错误提示（Message）	http status code	说明
InvalidParameterValue	invalid parameter value, parameter name: {parameter}	400	不合法的参数值, 参数名称: {参数}
DBInstanceNotFound	dbinstance not found	404	找不到实例
InternalFailure	internal failure	500	内部错误

请求示例

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
}

热门搜索

数据分析及可视化

数据研发

数据治理

数据服务化

计算服务

网络服务

数据库

消息

存储与 CDN

管理与监控

其他

查询RDS实例

接口方法：GET

url 参数

返回参数

状态码

请求示例

返回示例