查询RDS实例列表
更新时间 2025-11-05 15:37:11
最近更新时间: 2025-11-05 15:37:11
接口功能介绍
查询RDS实例列表
接口约束
无
URI
GET /PG/v1/product/page-paas-product
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNum | 是 | Integer | 当前页 | 1 | |
| pageSize | 是 | Integer | 页大小，范围1-1000 | 10 | |
| prodInstName | 否 | String | 实例名称，支持模糊匹配 | pg-test-s3 | |
| labelName | 否 | String | 标签名称（一级标签） | test | |
| labelValue | 否 | String | 标签值（二级标签） | test | |
| prodInstId | 否 | String | 实例id | 169528973574900007 | |
| instanceType | 否 | String | 实例类型，primary:主实例，readonly:只读实例，不传则查询全部实例 | primary | |
| obtainStatus | 否 | Boolean | 是否实时获取实例状态，true：实例状态，false：非实时获取 | false |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Project-Id | 否 | String | 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码 | 800 | |
| message | String | 消息提示 | SUCCESS | |
| error | String | 错误码 | ||
| returnObj | Object | 实例节点规格信息列表 | PageInfo | |
| 表 PageInfo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 页大小 | 10 | |
| total | Integer | 总记录数 | 1 | |
| pageTotal | Integer | 总页数 | 1 | |
| list | Array of Objects | 实例列表 | PagePaasProductVO | |
| 表 PagePaasProductVO |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| createTime | String | 创建时间 | 2023-09-21 17:49:52 | |
| prodDbEngine | String | 数据库实例引擎 | ||
| prodInstId | String | 实例id | 169528973574900007 | |
| prodInstName | String | 实例名称 | test_pg1 | |
| prodRunningStatus | Integer | 实例当前的运行状态 0:运行中 1:重启中 2:备份中 3:恢复中 1001:已停止 1006:恢复失败 1007:VIP不可用 1008:GATEWAY不可用 1009:主库不可用 1010:备库不可用 1021:实例维护中 2000:开通中 2002:已退订 2005:扩容中 2011:冻结 | 0 | |
| alive | Integer | 实例是否存活,0:存活，-1：异常 | 0 | |
| prodOrderStatus | Integer | 订单状态，0：正常，1：冻结，2：删除，3：操作中，4：失败,2005:扩容中 | 0 | |
| prodType | Integer | 实例部署方式 0：单机部署,1：主备部署 | 1 | |
| readPort | Integer | 读端口 | 9304 | |
| vip | String | 虚拟ip地址 | ||
| writePort | String | 写端口 | 9304 | |
| readonlyInstnaceIds | Array of Strings | 只读实例id列表 | [] | |
| instanceType | String | 实例类型，primary:主实例，readonly:只读实例 | primary | |
| toolType | Integer | 备份工具类型，1：pg_baseback，2：pgbackrest，3：s3 | 1 |
枚举参数
无
请求示例
请求url
https://pgsql-global.ctapi.ctyun.cn/PG/v1/product/page-paas-product?pageNum=1&pageSize=10
请求头header
{
"Project-Id":"0",
"regionId":"81f7728662dd11ec810800155d307d5b"
}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "SUCCESS",
"returnObj": {
"pageNum": 1,
"pageSize": 10,
"pageTotal": 1,
"total": 1,
"list": [
{
"prodInstId": "169528973574900007",
"prodInstName": "test_pg1",
"prodDbEngine": "12.7_P6",
"prodType": 1,
"prodRunningStatus": 0,
"alive": 0,
"prodOrderStatus": 0,
"vip": "",
"writePort": 9304,
"readPort": 9304,
"createTime": "2023-09-21 17:49:52",
"readonlyInstnaceIds ":[],
"instanceType ":"primary",
"toolType":1
}
]
},
"error": ""
}
状态码
请参考 状态码
错误码
请参考 错误码
