查询RDS实例的详细信息
更新时间 2026-05-06 11:05:02
最近更新时间: 2026-05-06 11:05:02
接口功能介绍
查询RDS实例的详情信息
接口约束
实例必须存活
URI
GET /PG/v1/product/get-paas-product
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | ||
| obtainStatus | 否 | Boolean | 是否实时获取实例状态，true：实时获取，false：非实时获取 | false |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Project-Id | 否 | String | 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 | 0 | |
| regionId | 是 | String | 资源池id，比如实例在资源池A，则需要填写A资源池的id。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码 | 800 | |
| message | String | 消息提示 | SUCCESS | |
| returnObj | Object | 分页展示的实例列表 | PaaspProductDetailVO | |
| error | String | 错误码 |
表 PaaspProductDetailVO
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alive | Integer | 实例是否存活,0:存活，-1:异常 | 0 | |
| createTime | String | 创建时间，格式为：yyyy:MM:dd HH:mm:ss | 2023-05-05 17:56:18 | |
| diskRated | Integer | 磁盘使用率 | 0 | |
| diskSize | Integer | 实例数据最大磁盘空间，单位G | 0 | |
| diskTotal | String | 磁盘总大小 | 24G | |
| diskType | String | 磁盘类型，例如：SATA，SSD | SATA | |
| diskUsed | String | 已使用磁盘 | 12G | |
| expireTime | String | 过期时间，格式：yyyy-MM-dd HH:mm:ss | 2023-05-05 17:56:18 | |
| machineSpec | String | 实例机器规格 | ||
| netName | String | VPC名称 | ||
| orderId | Integer | 订单id | 1 | |
| outerProdInstId | String | 对外的实例ID，对应PaaS平台 | ||
| prodDbEngine | String | 数据库实例引擎 | ||
| prodInstFlag | String | 实例标识 | ||
| prodInstId | String | 实例id | ||
| prodInstName | String | 实例名称 | ||
| prodInstSetName | String | 实例集群名称 | ||
| prodOrderStatus | Integer | 订单状态，0：正常，1：冻结，2：删除，3：操作中，4：失败,2005:扩容中 | 0 | |
| prodRunninStatus | Integer | 实例状态： 0:运行中 1:重启中 2:备份中 3:恢复中 1001:已停止 1006:恢复失败 1007:VIP不可用 1008:GATEWAY不可用 1009:主库不可用 1010:备库不可用 1021:实例维护中 2000:开通中 2002:已退订 2005:扩容中 2011:冻结 | 0 | |
| prodType | Integer | 实例部署方式 0：单机，1：一主一备，2：一主两备，3：只读实例 | 1 | |
| readPort | Integer | 读端口 | 5432 | |
| securityGroup | String | 安全组名称 | ||
| subnet | String | 子网名称 | ||
| userId | Long | 用户ID | 147 | |
| vip | String | 虚拟ip地址 | ||
| vip6 | String | vip6 | ||
| vpcId | String | VPCID | ||
| writePort | Integer | 写端口 | 6543 | |
| parameterGroupUsed | String | 参数配置所使用的名称，对应PaaS平台 | ||
| spuCode | String | 规格id | 10003011 | |
| toolType | Integer | 备份工具类型，1：pg_baseback，2：pgbackrest，3：s3 | 1 | |
| subnetId | String | 子网id | ||
| securityGroupId | String | 安全组id | ||
| hostSeries | String | 性能类型 | 鲲鹏通用型(一代机) | |
| backupDiskType | String | 备份空间类型 | ||
| backupDiskSize | String | 备份空间大小,当为对象存储时，不返回值 | ||
| backupUsageDiskSize | String | 备份已使用空间 | 10G | |
| backupFreeSpace | String | 备份免费空间 | 100G | |
| billMode | Integer | 计费模式,1包周期,2按需 |
枚举参数
无
请求示例
请求url
https://pgsql-global.ctapi.ctyun.cn/PG/v1/product/get-paas-product?prodInstId=4ac52d1ef0db40f8bb9516eb596fd231
请求头header
{
"Project-Id":"0",
"regionId":"81f7728662dd11ec810800155d307d5b"
}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "SUCCESS",
"returnObj": {
"outerProdInstId": "4ac52d1ef0db40f8bb9516eb596fd231",
"orderId": null,
"vpcId": "vpc-8ljsg4ndda",
"subnetId": "subnet-1hfzsz0upw",
"securityGroupId": "sg-wosbpdn9o1",
"userId": 9145,
"prodInstId": "4ac52d1ef0db40f8bb9516eb596fd231",
"prodInstFlag": "PostgreSQL",
"prodInstName": "pg-637-lz",
"prodInstSetName": "pg-637-lz",
"prodDbEngine": "12.20_P2",
"machineSpec": "2C4G",
"diskType": "SSD",
"diskSize": 100,
"prodType": 1,
"prodRunninStatus": 0,
"prodOrderStatus": 0,
"parameterGroupUsed": "",
"createTime": "2024-11-22 16:34:38",
"expireTime": "2024-12-22 16:36:31",
"netName": "vpc-dcp",
"subnet": "subnet-dcp",
"securityGroup": "Default-Security-Group",
"alive": 0,
"vip": "192.168.0.163",
"vip6": "",
"writePort": "6543",
"readPort": 6543,
"diskUsed": "SATA",
"diskTotal": "100G",
"diskRated": null,
"spuCode": "10003012",
"toolType": 2,
"hostSeries": "鲲鹏通用型(一代机)",
"backupDiskType": "SATA",
"backupDiskSize": "100G",
"backupUsageDiskSize": "0.00G",
"backupFreeSpace": "0G",
"billMode": 1
},
"error": ""
}
状态码
请参考 状态码
错误码
请参考 错误码
