查询指定实例详情
更新时间：2024-04-01
说明
- 查询指定实例的详细信息
请求结构
GET /v{version}/instance/{instanceId} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API 版本号 |
| instanceId | String | 是 | URL参数 | 指定实例ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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 | 否是历史代理实例 ，0：不是、1：是；当参数值是1时nodeAmount不展示。 |
| 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。 |
| 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）。 |
| incrementalDataBackupEnable | boolean | 是否开启高频备份，默认为 false。 |
| incrementalDataBackupInterval | Integer | 增量数据备份间隔（秒）最小粒度是小时级别。 |
| latestDataBackupRetainDays | Integer | 最新数据备份保留天数（实例删除后），天级别。 |
| retentionPeriod | Integer | 增量备份保留时长。 |
| timeUnit | String | 增量备份保留策略时长单位，取值为 week、month，默认为 week。 |
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 | 资源分组名称。 |
| extra | String | 扩展信息。 |
| parentUuid | String | 上级资源 ID。 |
| groupId | String | 分组 ID。 |
| accountId | String | 账户ID。 |
| userId | String | 用户ID。 |
| createTime | Timestamp | 创建时间。 |
| updateTime | Timestamp | 更新时间。 |
| deleteTime | Timestamp | 删除时间。 |
| bindTime | Timestamp | 绑定时间。 |
ResourceGroupsDetailFull
说明：ResourceGroupsDetailFull继承了ResourceInfo，
该类包含了ResourceInfo所有属性
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groups | List<ResourceInfo> | 集合ResourceInfo列表。 |
| name | String | 资源名称。 |
| type | String | 资源类型（产品类型）默认为RDS。 |
| region | String | 资源所属区域。 |
| id | String | 资源短 ID。 |
| uuid | String | 资源长 ID。 |
| summary | String | 日志。 |
| url | String | URL。 |
| accountId | String | 账户ID。 |
| userId | String | 用户ID。 |
| tag | List<Tag> | 分组标签。 |
| resUuid | String | 资源记录ID。 |
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> | 只读组列表。 |
| vpcVo | SimpleVpcVo | vpc对象。 |
| subnetVo | SubnetVo | 子网对象。 |
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。 |
SubnetVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| subnetId | String | 子网ID。 |
| name | String | 子网名称。 |
| az | String | 可用区。 |
| cidr | String | Ipv4地址。 |
| ipv6Cidr | String | Ipv6地址。 |
| vpcId | String | VPC长ID。 |
| vpcShortId | String | VPC短ID。 |
DccHostInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| master | DccHostId | 主节点dcc主机ID。 |
| backup | DccHostId | 备用节点dcc主机ID。 |
DccHostId
| 参数名称 | 类型 | 描述 |
|---|---|---|
| hostId | String | 主机ID。 |
| azone | String | 区域名称，如“zoneA"。 |
请求示例
GET /v1/instance/rds-efwefw 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
Server: BWS
{
"instanceId": "rds-efwefw",
"instanceShortId": "rds-efwefw",
"instanceName": "sdaysql57",
"engine": "MySQL",
"engineVersion": "5.7",
"rdsMinorVersion": "rds_5.7.38",
"characterSetName": "utf8",
"endpoint": {
"port": 3306,
"address": "mysql57.defefrfewfew.rds.bj.baidubce.com",
"vnetIp": "122.12.64.151",
"inetIp": ""
},
"instanceClass": "rds",
"allocatedMemoryInMB": 1024,
"allocatedMemoryInGB": 1.0,
"memoryCapacity": 1.0,
"allocatedStorageInGB": 50,
"volumeCapacity": 50,
"totalStorageInGB": 50,
"usedStorageInMB": 559,
"usedStorageInGB": 0.5458984375,
"usedStorage": 0.5458984375,
"cpuCount": 1,
"instanceType": "Master",
"sourceInstanceId": "",
"readReplicaNum": 0,
"readReplica": null,
"instanceStatus": "Available",
"lockMode": "unlock",
"eipStatus": "Closed",
"publicAccessStatus": "Closed",
"superUserFlag": "common",
"replicationType": "Async",
"syncMode": "Async",
"backupPolicy": {
"backupTime": "18:20:00Z",
"backupDays": "0,1,2,3,4,5,6",
"persistent": true,
"expireInDays": 7,
"logBackupRetainDays": 7,
"freeSpaceInGB": 50,
"dataBackupType": "snapshot",
"freeSpace": 50,
"dataBackupRetainStrategys": [
{
"startSeconds": 0,
"endSeconds": -604800,
"retainCount": 1,
"precision": 1
}
],
"incrementalDataBackupEnable": true,
"incrementalDataBackupInterval": 3600,
"latestDataBackupRetainDays": 30,
"timeUnit": "week"
},
"blbService": {
"status": "notCreated",
"service": null
},
"publiclyAccessible": false,
"instanceCreateTime": "2024-03-04T06:29:32Z",
"instanceExpireTime": null,
"productType": "Postpaid",
"paymentTiming": "Postpaid",
"topology": {
"master": [
"rds-dewedef"
],
"readReplica": [],
"rdsproxy": [],
"readReplicaIdMapping": [],
"rdsproxyIdMapping": {},
"masterIdMapping": {
"appId": "rdsmxyweqdqqvv0",
"appIdShort": "rds-ewqfdefre",
"status": "available",
"allocatedMemoryInMB": 1024,
"cpuCount": 1,
"allocatedStorageInGB": 50,
"usedStorageInGB": 0.5458984375
}
},
"azone": "zoneD",
"vpcId": "vpc-ewqdqwds",
"subnetId": {
"zoneD": "121bf5ef-dqdq-4dc8-34fqd-d32r4rdefa"
},
"region": "bj",
"sourceRegion": "bj",
"billingStatus": "available",
"applicationType": "Standard",
"nodeAmount": 1,
"oldInstance": 0,
"onlineStatus": 0,
"dccHostIds": null,
"machineType": "bcc",
"isSingle": null,
"weight": 1,
"nodeType": null,
"repairStartTime": null,
"repairEndTime": null,
"quotStatus": null,
"nodeReadReplica": null,
"nodeMaster": {
"id": "630bb987",
"azone": "zoneD",
"subnetId": "dfwefwef-89b7-4dc8-81d3-defd2fewfc233",
"name": "系统预定义子网D",
"vpcCidr": "192.168.64.0/20",
"shortId": "sbn-ewe3defd23"
},
"nodeSlave": {
"id": "35f50dc3",
"azone": "zoneD",
"subnetId": "78weqw-89b7-4dc8-81d3-cd8850e86ffa",
"name": "系统预定义子网D",
"vpcCidr": "192.168.64.0/20",
"shortId": "sbn-wdedfr4dq"
},
"nodeProxy": null,
"diskIoType": "cloud_enha",
"groupId": "",
"groupName": "",
"tdeStatus": "close",
"userId": null,
"bgwGroupId": null,
"bgwGroupExclusive": false,
"roGroupList": [],
"roGroupAbnormal": false,
"diskType": "cds",
"cdsType": null,
"maintainStartTime": "05:00:00",
"maintainDuration": 1,
"maintainPeriod": "1,2,3,4,5,6,7",
"instanceSubStatus": "available",
"bcmSendCycle": "60",
"autoResizeDisk": 0,
"edgeRegion": null,
"edgeRegionName": null,
"edgeVpcId": null,
"edgeSubnetId": null,
"gtidType": null,
"haStrategy": 0,
"replicaType": "",
"nodeMasterReadReplica": null,
"nodeBackupReadReplica": null,
"resourceType": "exclusive",
"phpAdminUrl": null,
"dmsUrl": null,
"timestamp": "2024-03-05T04:05:31Z",
"vpcName": "default",
"vpcCidr": "192.168.0.0/16",
"vpcShortId": "vpc-70pxg3pmv8rv",
"subnets": [
{
"name": "系统预定义子网D",
"subnetId": "sbn-dqafncqsy3y4",
"az": "cn-bj-d",
"zoneName": "cn-bj-d",
"cidr": "192.168.64.0/20",
"shortId": "sbn-dqafncqsy3y4"
}
],
"zoneNames": [
"cn-bj-d"
],
"orderStatus": null,
"resourceUuid": "8d0616bb-f261-43b9-8b07-b0785f848923",
"dccHosts": null,
"category": "Standard",
"resourceGroup": {
"name": "DEV-mysql57",
"type": "RDS",
"region": "bj",
"id": "rds-S8hpDQpq",
"uuid": "rdsmxym5zhkkvv0",
"summary": "",
"url": "https://console.bce.baidu.com/rds/#/rds/detail~instanceId=rdsmxym5zhkkvv0",
"accountId": "22fddddddddewfr4r42dffc4f3f3rf3r",
"userId": "22fddddddddewfr4r42dffc4f3f3rf3r",
"tags": [],
"resUuid": null,
"groups": [
{
"name": "默认分组",
"extra": "",
"parentUuid": "",
"groupId": "RESG-Txhj8fhEJRw",
"accountId": "22fddddddddewfr4r42dffc4f3f3rf3r",
"userId": "22fddddddddewfr4r42dffc4f3f3rf3r",
"createTime": 1631865612000,
"updateTime": 31536000000,
"deleteTime": null,
"bindTime": "2024-03-04T06:33:05Z"
}
]
},
"unitPrice": "12.08304元/天",
"orderId": "54576ghjgrg454t5t45g4gfdw3444",
"single": null
}更新历史
| 日期 | 更新内容 |
|---|---|
| 2024-03-11 | 实例信息新增资源分组相关内容 |
