接口描述

分页查询实例列表。

请求方法

GET

URI

/v1/product/page-paas-product

请求参数

名称	位置	类型	必选	说明
pageNum	query	Integer	是	当前页
pageSize	query	Integer	是	页大小，范围1-500
prodInstName	query	string	否	实例名称，支持模糊匹配

响应参数

名称			类型	说明
message			String	消息提示
statusCode			Integer	状态码
returnObj			Object	所有的返回信息都以JSON形式保存
	pageNum		Integer	当前页
	pageSize		Integer	页大小
	total		Integer	总记录数
	pageTotal		Integer	总页数
	list		Array	实例列表
		createTime	Long	创建时间
		prodDbEngine	String	数据库实例引擎
		prodInstId	Long	实例id
		prodInstName	String	实例名称
		prodRunningStatus	Integer	实例当前的运行状态 0:运行中 1->重启中 2:备份中 3:恢复中 4:修改参数中 5:使用参数分组 6:扩展处理 7:扩展完成 8:修改端口中 9:切换主备中
		alive	Integer	实例是否存活, 0:存活，-1：异常优先级依次递减prodOrderStatus > prodRunningStatus > alive，前面为0的情况下才会取下一个状态位
		prodOrderStatus	Integer	订单状态，0：正常，1：冻结，2：删除，3：操作中，4：失败
		prodType	Integer	实例部署方式0：单机部署,1：主备部署
		readPort	Integer	读端口
		vip	String	虚拟ip地址
		writePort	String	写端口

示例

请求示例

/v1/product/page-paas-product?pageNum=1&pageSize=10

响应示例

{
  "message": "SUCCESS",
  "returnObj": {
    "list": [
      {
        "alive": 0,
        "createTime": 1663312182000,
        "prodDbEngine": "12.3",
        "prodInstId": 10,
        "prodInstName": "pg-test-s3",
        "prodOrderStatus": 0,
        "prodRunningStatus": 2,
        "prodType": 1,
        "readPort": 5210,
        "vip": "192.168.1.14",
        "writePort": 5220
      },
      {
        "alive": 0,
        "createTime": 1663312500000,
        "prodDbEngine": "12.3",
        "prodInstId": 12,
        "prodInstName": "PGSql-9r3e",
        "prodOrderStatus": 0,
        "prodRunningStatus": 0,
        "prodType": 1,
        "readPort": 5632,
        "vip": "192.168.1.13",
        "writePort": 5432
      }
    ],
    "pageNum": 1,
    "pageSize": 10,
    "pageTotal": 1,
    "total": 2
  },
  "statusCode": 800
}

错误码

访问ErrorCodes说明文档查看更多错误码。

关系数据库PostgreSQL版

查询Postgresql实例列表