查询实例列表
更新时间：2024-11-27
说明
- 只能查看属于自己账号的实例列表
- 接口将每个主实例和其只读、代理实例分成一组，参数maxKeys代表分组数，也就是主实例的个数
请求结构
GET /v{version}/instance?marker={marker}&maxKeys={maxKeys} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | Integer | 是 | URL参数 | API 版本号 |
| marker | String | 否 | Query参数 | 查找marker在分页主实例列表的起始位置，配合maxKeys使用。 表示匹配到makrer关键词的分页主实列表索引位置到maxKeys索引位置，获取这之间的数据。 不传递marker系统默认值为-1 （表示从列表索引第一条开始） |
| maxKeys | Integer | 否 | Query参数 | 每页包含的最大数量(主实例)，最大数量通常不超过1000，缺省值为1000 |
| vnetIp | String | 否 | Query参数 | 查询指定的内网IP，支持模糊搜索 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 获取匹配到marker主实列表的查询的实例ID，不传递 marker，系统默认为-1 |
| maxKeys | Integer | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
| isTruncated | Boolean | true表示后面还有数据，false表示已经是最后一页 |
| instances | List<Instance> | Instance对象数组 |
| nextMarker | String | 下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
Instance对象数组
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 实例ID |
| instanceShortId | String | 实例短ID |
| instanceName | String | 实例名称 |
| engine | String | 数据库引擎,参见引擎类型 |
| engineVersion | String | 数据库引擎版本,取值参考数据库版本 |
| rdsMinorVersion | String | 实例小版本 |
| characterSetName | String | 指定实例字符集有"utf8mb4","latin1","gbk","utf8"可选，默认为"utf8"（目前只支持mysql主实例） |
| endpoint | Endpoint | 数据库连接信息对象 |
| instanceClass | String | 实例分类 。MASTER(主实例)，REPLICA（只读实例）,PROXY（代理实例） |
| allocatedMemoryInMB | Integer | 分配内大小（单位：MB） |
| allocatedMemoryInGB | Double | 分配内存大小（单位：GB） |
| memoryCapacity | Double | 实例内存（单位：GB） |
| allocatedStorageInGB | Integer | 分配存储存空间（单位：GB） |
| volumeCapacity | Integer | 存储空间（单位：GB） |
| totalStorageInGB | Integer | 磁盘总大小（单位：GB） |
| usedStorageInMB | Integer | 已经使用存储空间（单位：MB） |
| usedStorageInGB | Double | 已经使用存储空间（单位GB） |
| usedStorage | Double | 已用存储空间（单位GB） |
| cpuCount | Integer | CPU核数 |
| instanceType | String | 实例类型，参考实例类型 |
| sourceInstanceId | String | 主实例ID，如果为主实例则为空 |
| readReplicaNum | Integer | 只读实例数量 |
| readReplica | List<String> | 只读实例名称的集合 |
| instanceStatus | String | 实例状态，参见实例状态表 |
| lockMode | String | 实例锁定状态： unlock：解锁 lockExpiration：锁过期 lockDiskQuota：锁定磁盘配额 |
| eipStatus | String | 外网访问功能状态，参考公网状态表 |
| publicAccessStatus | String | 外网访问功能状态，参考公网状态表 |
| superUserFlag | String | 账号权限类型，取值是super或common super：读写账号 common：只读账号 |
| replicationType | String | 数据复制方式： async：异步复制 semi_sync：半同步复制 |
| syncMode | String | 数据同步方式,参考同步方式 |
| blbService | BlbService | 服务发布点 |
| publiclyAccessible | Boolean | 是否可访问公网， true 可以，false不可以 |
| instanceCreateTime | Datetime | 实例创建时间，规范参考时间与日期 |
| instanceExpireTime | Datetime | 实例到期时间，规范参考时间与日期 |
| productType | String | 付费方式，预付费：postpay，后付费：prepay |
| paymentTiming | String | 付费方式， 预付费：Prepaid，后付费：Postpaid |
| topology | Topology | 实例所属数据库集群的拓扑信息 |
| azone | String | 实例的逻辑可用区名字 ,多个逗号分隔。如：zoneD,zoneE |
| vpcId | String | 实例所属VPC的ID |
| subnetId | Map | 实例所在子网json字符串，格式为 {znoe：znoe值}。如： {"zoneD": "121bf5ef-89b7-4dc8-81d3-cd8850e86ffa","zoneE": "87d3c2d1-1059-484a-8b57-40ee473405fd"} |
| region | String | 该实例的地域首字母。如bj |
| sourceRegion | String | 该实例的主实例的区域。如bj |
| billingStatus | String | 订单状态。有以下状态： AVAILABLE：运行中 CREATEING：创建中 CREATED：已创建 CREATE_FAILED：创建失败 NEED_PURCHASE：未支付 CANCELLED：取消支付 |
| applicationType | String | 所属系列，single：单机基础版，normal：双机高可用版 |
| nodeAmount | Integer | 节点数（代理实例） |
| oldInstance | Integer | 旧实例数量 |
| onlineStatus | Integer | 在线状态，0：下线、1：上线 |
| isSingle | Boolean | 是否单机实例，true：是，false：否 |
| dccHostIds | DccHostInfo | dcc主机信息 |
| machineType | Integer | 主机类型，默认只有dcc |
| weight | Integer | 权重 |
| nodeType | String | 节点类型,默认为空，没有返回值 |
| repairStartTime | Datetime | 维护开始时间，规范参考时间与日期 |
| repairEndTime | Datetime | 维护结束时间，规范参考时间与日期 |
| quotStatus | String | 分配状态： pendingRepair（待分配） processing（分配中） solved（已分配） |
| nodeReadReplica | RoleInfo | 只读副本节点 |
| nodeMaster | RoleInfo | 主节点 |
| nodeSlave | RoleInfo | 从节点 |
| nodeProxy | RoleInfo | 代理节点 |
| diskIoType | String | 磁盘类型： normal_io : 本地盘ssd磁盘 cloud_high : 高性能云磁盘 cloud_nor : 通用型SSD cloud_enha: 增强型SSD |
| groupId | String | 分组ID |
| groupName | String | 分组名称 |
| tdeStatus | String | 透明数据加密状态：close：（关闭）、open（打开） |
| userId | String | 用户ID |
| bgwGroupId | String | 如果bgwGroupExclusive为true，若创建实例时指定了专属集群ID，则将blb分配到指定的专属集群，如果不传按照默认情况 |
| bgwGroupExclusive | Boolean | 负载均衡集群属性，true表示指定专属集群，false表示使用共享集群。 |
| roGroupList | List<RoGroup> | 只读组列表 |
| roGroupAbnormal | Boolean | 是否为异常只读组。true：是，false：不是；默认是false |
| diskType | String | 磁盘类型：云磁盘（cds），本次磁盘（sds）。 diskIoType字段值为cloud_nor,cloud_high,cloud_enha,参数值为：cds。 diskIoType字段值为normal_io，参数值为：ssd |
| cdsType | String | cds类型有以下几种情况： diskIoType字段值为cloud_nor，参数值为：premium_ssd（光威磁盘） diskIoType字段值为cloud_high，参数值为：ssd diskIoType字段值为cloud_enha，参数值为：enhanced_ssd_pl1（高性能通用型磁盘） diskIoType字段值为normal_io，参数值为：“” |
| maintainStartTime | String | 维护时间窗口 |
| maintainDuration | Integer | 维护时间窗口时长（单位:小时） |
| maintainPeriod | String | 维护时间窗口的持续时间 |
| instanceSubStatus | String | 实例状态，参考实例类型 |
| autoResizeDisk | Integer | 自动扩容磁盘大小（单位：GB） |
| edgeRegion | String | 边缘区域 |
| edgeRegionName | String | 边缘区域名称 |
| edgeVpcId | String | 边缘 VpcID |
| edgeSubnetId | String | 边缘子网ID |
| nodeMasterReadReplica | RoleInfo | 高可用只读实例主节点数据 |
| nodeBackupReadReplica | RoleInfo | 高可用只读实例备份节点数据 |
| haStrategy | Integer | 高可用切换策略。0：立即切换，1：维护时间切换 |
| location | String | 区域位置 |
| hasSlave | Boolean | 是否有从节，true：有、false：没有；默认是false |
| expireDate | Integer | 过期日期，默认是0 |
| hasProxy | Boolean | 是否有代理，true：有、false：没有；默认是false |
| vpcName | String | vpc名称 |
| resourceUuid | String | 资源，唯一序列ID |
| tags | List<Tag> | 分组标签 |
| task | String | 相关任务， 如自动续费（目前只有这个） |
| orderStatus | String | 相关联的计费变更订单的类型to_prepay、 to_postpay两种 |
| vpcCidr | String | VPC的IP地址及子网掩码 |
| zoneNames | List<String> | 实例的可用区名称，数组列表 |
| dccHosts | List<MachinePO> | dcc主机对象 |
| category | String | 所属系列。Singleton：单机基础版，null：双机高可用版 |
| name | String | 实例名称，只给iam的实例列表接口使用，其他接口不要用 |
| resourceGroup | ResourceGroupsDetailFull | 资源分组详情 |
| resourceGroupId | String | 资源分组ID |
| resourceGroupName | String | 资源分组名称 |
SnapshotPolicy
| 参数名称 | 类型 | 描述 |
|---|---|---|
| backupTime | String | 备份时间. 时:分:秒Z |
| backupDays | String | 以英文半角逗号分隔的备份时日间，周日为第一天 |
| persistent | Boolean | 是否启用备份数据持久化。 true：是 ，false：否 |
| expireInDays | Integer | 持久化天数（单位:天数） |
| logBackupRetainDays | Integer | 日志备份保留时长（单位:天数） |
| freeSpaceInGB | Integer | 空闲空间大小（单位:GB） |
| dataBackupType | String | 备份类型，支持physical/snapshot， 取值为：snapshot，磁盘类型为ssd将不支持快照备份 |
| freeSpace | Integer | 空闲空间大小（单位:MB） |
BlbService
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 服务状态，有以下几种状态： notCreated（没创建） creating（创建中） created（已创建） deleting（删除中） deleted （已删除） |
| service | String | 服务的域名 |
Topology
| 参数名称 | 类型 | 描述 |
|---|---|---|
| master | List<String> | 主实例列表 |
| readReplica | List<String> | 只读实列列表 |
| rdsproxy | List<String> | 代理实例列表 |
| readReplicaIdMapping | List<ReadReplicaIdMapping> | 只读实例映射 |
| masterIdMapping | MasterIdMapping | 主实例映射，字段同ReadReplicaIdMapping对象 |
dcc MachinePO主机
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | Integer | dcc主机ID |
| updatedTime | Datetime | 更新时间，规范参考时间与日期。 |
| instanceId | String | 实例ID |
| machineInstanceId | String | 机器实例ID |
| machineInstanceName | String | 机器实例名 |
| machineInstanceStatus | String | 实例状态，参见实例状态表 |
| available | Boolean | 是否可用，true：是 false：否 |
| instanceRole | String | 实例角色 |
| machineType | String | 主机类型，默认只有dcc |
| azone | String | 实例的逻辑可用区 |
ResourceInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 资源名称 |
| type | String | 资源类型（产品类型）默认为RDS |
| region | String | 可用区域 |
| id | String | 资源ID |
| uuid | String | 唯一序列 |
| summary | String | 日志 |
| url | String | URL |
| accountId | String | 账户ID |
| userId | String | 用户ID |
| tag | List<Tag> | 分组标签 |
ResourceGroupsDetailFull
说明：ResourceGroupsDetailFull继承了ResourceInfo，该类包含了ResourceInfo所有属性
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groups | List<ResourceInfo> | 集合ResourceInfo列表 |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签名 |
| tagValue | String | 标签值 |
ReadReplicaIdMapping
| 参数名称 | 类型 | 描述 |
|---|---|---|
| appId | String | 只读实例ID |
| appIdShort | String | 只读实例短ID |
| status | String | 只读实例状态，参考公网状态表 |
| allocatedMemoryInMB | Integer | 分配内存大小（单位:MB） |
| cpuCount | Integer | cpu个数 |
| allocatedStorageInGB | Integer | 分配存储大小（单位GB） |
| usedStorageInGB | Double | 分配存储大小（单位GB） |
RoleInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 节点ID |
| azone | String | 可用区名称，多个逗号分隔 |
| subnetId | String | 子网ID，多个逗号分隔 |
| name | String | 角色名称 |
| vpcCidr | String | VPC地址 |
| ShortId | String | 短ID |
RoGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| roGroupId | String | 节点ID |
| roGroupName | String | 可用区名称，多个逗号分隔 |
| roGroupEndpoint | InstanceDict | 只读组发布点 |
| vpcId | String | vpcID |
| subnetId | String | VPC地址 |
| eipStatus | String | 外网访问功能状态,参考公网状态表 |
| roGroupAppList | List<AppList> | 只读组列表 |
| SimpleVpcVo | SimpleVpcVo | vpc对象 |
| subnetVo | SubnetVo | 子网对象，同SimpleVpcVo结构 |
InstanceDict
| 参数名称 | 类型 | 描述 |
|---|---|---|
| port | Integer | 端口 |
| vnetIp | String | 内网IP |
| inetIp | String | 外网IP |
| address | String | 域名 |
Endpoint
| 参数名称 | 类型 | 描述 |
|---|---|---|
| port | Integer | 端口 |
| vnetIp | String | 内网IP |
| inetIp | String | 外网IP |
| address | String | 域名 |
| inetIpV6 | String | 外网IPV6地址 |
| vnetIpV6 | String | 内网IPV6地址 |
AppList
| 参数名称 | 类型 | 描述 |
|---|---|---|
| appId | String | 只读实例ID |
| appName | String | 只读实例名称 |
| weight | Integer | 只读实例权重 |
| roGroupId | String | 只读组ID |
| sourceAppId | String | 资源ID |
| status | String | 只读组实例状态：joining(正在加入RO组), online(已加入RO组), leaving(正在离开RO组), offline(已离开RO组), weightUpdating(在更新权重),delay_offline(正在更新权重) |
| createTime | String | 创建时间 |
| updateTime | String | 更新时间 |
| appStatus | String | 只读实例状态，参见实例状态表 |
| appIdShort | String | 只读实例短ID |
SimpleVpcVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| vpcId | String | vpcID |
| shortId | String | vpc短ID |
| name | String | vpc名称 |
| cidr | String | Ipv4地址（vpc主网络） |
| status | Integer | 子网状态， 0表示可用、1表示创建中、大于等于2时表示不可用 |
| createTime | Date | 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' |
| description | String | 子网描述 |
| defaultVpc | Boolean | 是否默认子网。 true：有、false：没有；默认false |
| ipv6Cidr | String | IPv6地址 |
| auxiliaryCidr | List<String> | Ipv4地址（vpc辅网络） |
| relay | Boolean | 是否开启replay。true：开启、false：未开启；默认false |
DccHostInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| master | DccHostId | 主节点dcc主机ID |
| backup | DccHostId | 备用节点dcc主机ID |
DccHostId
| 参数名称 | 类型 | 描述 |
|---|---|---|
| hostId | String | 主机ID |
| azone | String | 区域名称，如“zoneA" |
请求示例
GET /v1/instance?marker=r-IyWRtII7&maxKeys=1 HTTP/1.1
HOST: rds.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 返回示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
"marker": "rds-4xSw4VMK",
"isTruncated": true,
"nextMarker": "rds-ITHVf5Sm",
"maxKeys": 1,
"instances": [
{
"instanceId": "rds-4xSw4VMK",
"instanceShortId": "rds-4xSw4VMK",
"instanceName": "",
"engine": "",
"engineVersion": "",
"rdsMinorVersion": null,
"characterSetName": null,
"endpoint": {},
"instanceClass": null,
"allocatedMemoryInMB": 0,
"allocatedMemoryInGB": 0.0,
"memoryCapacity": 0.0,
"allocatedStorageInGB": 0,
"volumeCapacity": 0,
"totalStorageInGB": 0,
"usedStorageInMB": 0,
"usedStorageInGB": 0.0,
"usedStorage": 0.0,
"cpuCount": 0,
"instanceType": "Master",
"sourceInstanceId": null,
"readReplicaNum": null,
"readReplica": null,
"instanceStatus": "NotExist",
"lockMode": null,
"eipStatus": null,
"publicAccessStatus": null,
"superUserFlag": null,
"replicationType": null,
"syncMode": null,
"backupPolicy": {
"backupTime": "00:00:00Z",
"backupDays": "0,1,2,3,4,5,6",
"persistent": false,
"expireInDays": 7,
"logBackupRetainDays": 7,
"freeSpaceInGB": 0,
"dataBackupType": null,
"freeSpace": null
},
"blbService": {
"status": null,
"service": null
},
"publiclyAccessible": false,
"instanceCreateTime": "2023-06-07T03:56:04Z",
"instanceExpireTime": null,
"productType": "postpay",
"paymentTiming": "postpay",
"topology": {
"master": [],
"readReplica": [],
"rdsproxy": [],
"readReplicaIdMapping": [],
"masterIdMapping": null
},
"azone": "zoneA",
"vpcId": null,
"subnetId": {},
"region": null,
"sourceRegion": null,
"billingStatus": null,
"applicationType": "Standard",
"nodeAmount": null,
"oldInstance": 0,
"onlineStatus": 0,
"dccHostIds": null,
"machineType": null,
"isSingle": null,
"weight": null,
"nodeType": null,
"repairStartTime": null,
"repairEndTime": null,
"quotStatus": null,
"nodeReadReplica": null,
"nodeMaster": null,
"nodeSlave": null,
"nodeProxy": null,
"diskIoType": null,
"groupId": null,
"groupName": null,
"tdeStatus": null,
"userId": null,
"bgwGroupId": null,
"bgwGroupExclusive": false,
"roGroupList": null,
"roGroupAbnormal": false,
"diskType": null,
"cdsType": null,
"maintainStartTime": null,
"maintainDuration": null,
"maintainPeriod": null,
"instanceSubStatus": null,
"bcmSendCycle": null,
"autoResizeDisk": null,
"edgeRegion": null,
"edgeRegionName": null,
"edgeVpcId": null,
"edgeSubnetId": null,
"haStrategy": null,
"location": null,
"hasSlave": false,
"expireDate": 0,
"hasProxy": false,
"vpcName": null,
"resourceUuid": null,
"tags": [],
"task": null,
"orderStatus": null,
"vpcCidr": null,
"zoneNames": [
"cn-bj-a"
],
"dccHosts": null,
"category": null,
"name": null,
"resourceGroup": null,
"single": null
}
]
}更新历史
| 日期 | 更新内容 |
|---|---|
| 2024-03-11 | 实例信息新增资源分组相关内容 |
