名称 位置 类型 必选 说明 prodInstId query String 是 实例id

名称 二级节点 位置 类型 必选 说明 labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 是 标签列表,一次最多只能新增50个 labelName body String 是 资源标签名称，同一租户下标签名称唯一、平台标签名称唯一 labelValue body String 否 标签值 remark body String 否 标签说明

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象

参数 是否必填 参数类型 说明 示例 下级对象 vpcId 否 String VPC ID cfcbed30ca9e432daa8b87ef0eb6a9aa

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labelIds body List 是 标签id列表,一次最多只能设置20个

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 开始时间，格式：yyyyMMdd HH:mm:ss endTime query String 是 结束时间，格式：yyyyMMdd HH:mm:ss pageNum query Integer 是 当前页 pageSize query Integer 是 页大小，范围1500

名称 位置 类型 必选 说明 srcProdInstId body Long 是 源pg实例id backupId body Long 否 备份id,和restoreTime只能有一个为空 destProdInstId body Long 是 目标实例id restoreTime body String 否 备份保留周期内的任意时间点。格式：yyyyMMdd HH:mm:ss

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 backupName 是 String 备份名称 1. 长度为1100个字符 2. 由数字、中文、英文、下划线（）、短横线（）组成 test

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

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 20221122 10:00:00

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id retain body Integer 是 备份保留份数，0表示全部清除,最大保留份数为7，即取值范围07 autoBackup body Integer 是 自动备份开关，0表示关闭，1表示打开 weekdays body List 是 自动备份的日期列表 autoBackupTime body String 是 自动备份时间

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id backupName body String 是 备份名称

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id machineId body Long 是 机器资源唯一标识 storePath body String 是 存储位置 retain body Integer 是 备份保留份数，0表示全部清除，最大保留份数为7，即取值范围07 autoBackup body Integer 是 自动备份开关，0表示关闭，1表示打开 weekdays body List 是 自动备份的日期列表 autoBackupTime body String 是 自动备份时间

接口描述 重置实例的账号密码。 请求方法 POST URI /v1/instuser/resetpassword 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 password body String 是 用户密码 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/resetpassword { "password": "123456", "prodInstId": "165776586159600008", "username": "pguser" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 查看已删除实例的备份集列表 请求方法 GET URI /v1/backup/pagedetachedlist 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id backupName query String 否 备份名称，支持模糊查询 result query Integer 否 备份结果，0：正在备份，3：成功，5：失败 selectType query Integer 否 备份类型，1:自动，2：手动，3：恢复 startTime query String 否 备份开始时间，格式：yyyy:MM:dd HH:mm:ss endTime query String 否 备份结束时间，格式：yyyy:MM:dd HH:mm:ss pageNum query Integer 是 当前页,默认1 pageSize query Integer 是 页大小，默认10，最大限制500 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object pageNum Integer 当前页 pageSize Integer 页大小 pageTotal Integer 页码总数 total Integer 总记录数 list Array 记录 id Integer 备份集id prodInstId Integer 实例id backupName String 备份名称 type Integer 备份类型，1：自动备份，2：手动备份，3：恢复备份 result Integer 备份结果，0：运行中，3：备份成功，5：备份失败 startTime Long 备份开始时间 endTime Long 备份结束时间 dataLen String 备份大小

接口描述 查询RDS实例的SQL洞察日志保存时长。 接口约束 实例需要已开启SQL洞察 URI GET /v1/collector/sqlcollectorretention 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Integer 返回对象 30 请求示例 /v1/collector/sqlcollectorretention?prodInstId10 请求体body 响应示例 { "message": "SUCCESS", "returnObj": 30, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

参数 是否必填 参数类型 说明 示例 下级对象 instId 是 String 实例id

接口描述 修改实例的描述，描述最大长度为1KB 请求方法 PUT URI /v1/product/description 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id description body String 是 最大长度不超过1KB,最小长度为0；输入空字符串表示清空描述 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/product/modifyProductDescription { "description": "instance", "prodInstId": 15 } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 资源池信息列表 List

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存

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

接口描述 查看通知消息列表 请求方法 GET URI /v1/notify/query 请求参数 名称 位置 类型 必选 说明 pageNum query Integer 是 页码 pageSize query Integer 是 页大小 startTime query Long 否 查询开始时间，格式：时间戳 endTime query Long 否 查询结束时间，格式：时间戳 withConfirmed query Boolean 否 结果是否包含已确认的通知，true为包含，默认为true 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 pageNum Integer 页码 pageSize Integer 每页最大条数 total Integer 总记录数 pageTotal Integer 总页数 List Array confirmFlag Boolean 通知是否确认，true为已确认 notifyContent String 通知内容： 实例创建是否成功、实例已删除、实例已暂停 notifyId Integer 通知唯一ID notifyLevel String 通知等级： notice:普通通知 warning:提醒通知 notifyTime String 创建时间 notifyType String 通知类型： InstanceOperation：实例操作 updateTime String 更新时间 userId Long 用户ID

名称 位置 类型 必选 说明 enable body Boolean 是 功能启用标志

接口描述 查询RDS实例的高可用模式和数据复制方式。 请求方法 GET URI /v1/product/sync 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 sync Boolean 是否同步 true:同步模式 false：异步模式 示例 请求示例 /v1/product/getPassProductSync?prodInstId1 响应示例 { "message": "SUCCESS", "returnObj": { "sync": false }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 SubnetVO

参数 参数类型 说明 示例 下级对象 accountId String 账户ID 5a101a9e7d2e4df0af71742390db1504 createDate String 创建时间 20221025T06:32:17Z dueDate String 到期时间 20221025T06:32:17Z hostId String 带宽对应的主机id，如果是单独订购的带宽没有此值，绑定后才有 7767857af3c24467b1efbca506cf7a26 id String uuid deacf1fab55c4c5ab277410602e9fed5 ipAddress String 公网ip地址 55.55.2.103 ipStatus Integer 带宽的真实状态。0：未绑定；1：已绑定；2：绑定中；3：解绑中；1：ERROR；9999：DELETE 1 iptype String ip类型 IPV4 isPackaged Integer 是否成套，1成套 0非成套 1 name String 带宽名称 orderId String 订单id 08b2c3833e0146bb8d1a7f21e9d3697d regionId String 资源池ID 100054c0416811e9a6690242ac110002 regionName String 资源池名称 保定os resIpAddressId String 带宽ipid cdce17c8c33a4c3ba8c687227f64a920 resourceType String 资源类型 INSTANCE speed Integer 带宽大小 1 status Integer 带宽状态。2正常(CREATESUCCEED)；22执行续订(RENEWING)；33执行变更(CHANGEING)；55执行退订(UNSUBSCRIBING)；5已退订(UNSUBSCRIB)；6已超时(OVERTIMESUCCEED)；7已销毁(DESTORY) 2 updateDate TIMESTAMP 更新时间 1666679332000 userId String 用户id 5a101a9e7d2e4df0af71742390db1504 virtualmachinename String 虚拟机名称 htaptest741 vmName String 虚拟机名称 htaptest741 vpcId String 带宽对应的vpcid vpcname String vpc名称 vpc3t68 workOrderResourceId String 虚拟资源id 417af50b6fdd4ba7818ba93e2ba4af42 zoneId String 资源池可用区id zoneName String 资源池名称

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 master ProductNetInfo 主节点连接信息 ip String 连接ip port String 连接端口 slaves List 从节点连接信息，单节点实例为null vip ProductNetInfo vip连接信息，单节点实例为null

请求示例 /v1/eop/reneworderprice 请求体body { "cycleType":3, "cycleCount":1, "resourceIds":[ "dc7af3591eff44dd800ea0cbce23d917" ] } 响应示例 { "message": "SUCCESS", "returnObj": [ { "isSucceed": true, "totalPrice": 542.0, "finalPrice": 542.0, "subOrderPrices": [ { "totalPrice": 542.0, "finalPrice": 542.0, "serviceTag": "PAAS", "orderItemPrices": [ { "itemId": "a0782b8992fe436cb497f7ee7c162a2c", "resourceType": "PGSQLVM", "totalPrice": 462.0, "finalPrice": 462.0 }, { "itemId": "5a9868068fe941ea8d81a38c97f36e06", "resourceType": "PGSQLEBSC", "totalPrice": 50.0, "finalPrice": 50.0 }, { "itemId": "1daaeb363cc949929cfd29745a6750ce", "resourceType": "PGSQLBACKUP", "totalPrice": 30.0, "finalPrice": 30.0 } ] } ] } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

参数 是否必填 参数类型 说明 示例 下级对象 resourceIds 是 Array 需要退订的主资源ID ["resourceId1","resourceId2"] String

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 OrderResponse