名称 位置 类型 必选 说明 enableEventLog query Boolean 是 开启或关闭历史事件功能

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object pageNum Integer 页码 pageSize Integer 每页最大条数 total Integer 总记录数 pageTotal Integer 总页数 list Array eventId String id prodInstId String 实例ID eventType String 事件类型 eventName String 事件名称 eventTime String 事件发生时间 eventUserType String 事件发起人 eventReason String 事件产生原因 userId Integer 用户ID eventPayload String 请求参数

名称 二级节点 三级节点 四级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id nodes List 实例各个节点性能信息 ip String 节点ip master boolean 是否主节点 metrics List 时间范围类各个时间点性能指标 cpuUser Byte 监控数据采集时间间隔内，cpu处于用户态的时间比例,单位% cpuSys Byte 监控数据采集时间间隔内，cpu处于内核态的时间比例，单位% rRateKbs BigDecimal io读速率，单位kb/s wRateKbs BigDecimal io写速率，单位kb/s ioUtil BigDecimal io利用率,单位% qps Integer 节点qps tps Integer 节点tps collectTime String 数据采集时间

接口描述 删除数据库账号。调用该接口时，实例状态需要为运行中，否则将操作失败。 请求方法 POST URI /v1/instuser/drop 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 force body Boolean 否 是否强制删除，默认为false。 当用户存在某对象的权限或者其他依赖关系时，删除账号会失败； 此参数为true时，账号拥有的对象以及拥有写权限的对象（包括table，schema等） 均会被强制删除，请谨慎用此选项 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/drop { "force": true, "prodInstId": "165776586159600008", "username": "test1" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

接口功能介绍 查询可用于恢复的目标实例列表 接口约束 无 URI GET /v1/backup/dstprod 请求参数 query参数 参数 是否必填 参数类型 说明 示例 prodInstId 是 Integer 实例id 54 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] BackupProdVo BackupProdVo 参数 类型 说明 prodInstFlag String 数据库类型，PostgreSQL或者OpenGauss prodInstName String 实例名 prodInstSetName String set名 prodInstId Long 实例id 请求示例 /v1/backup/dstprod?prodInstId54 请求参数 响应示例 json { "message": "SUCCESS", "returnObj": [ { "prodInstFlag": "PostgreSQL", "prodInstName": "PostgreSQLset11125100", "prodInstSetName": "set11125100", "prodInstId": 54 } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object

参数 参数类型 说明 示例 下级对象 id Long 修改记录标识id 1 instId Long 实例id 54 tenantId Long 租户id 1 opType String 操作类型，取值说明： add新增行记录， delete删除行记录， modify修改属性记录 add line Integer 所操作的记录在hba文件中对应的行数 10 item String 操作的属性，仅当opType为modify时才有值 type: 连接类型 database：数据库 username：账号 database oldVal String 初始值，操作类型为add时，值为空 test newVal String 修改后的值，操作类型为delete时，值为空 portgres createTime String 修改时间，格式为yyyyMMdd HH:mm:ss 20221017 12:00:00

参数 是否必填 参数类型 说明 示例 下级对象 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 是 自动备份时间

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号

本节介绍如何解决HTTPS请求在部分手机访问异常。 打开手机浏览器，访问防护域名，如果出现类似如图所示的页面，则表示该手机上HTTPS请求访问异常，该问题是由于上传的证书链不完整，可参照如何解决证书链不完整？解决。

接口描述 重置实例的账号密码。 请求方法 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说明文档查看更多错误码。

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 pageNum 是 Integer 页码最小值为1 1 pageSize 是 Integer 页大小取值范围为：1500 10 fileName 否 String 审计文件名称 postgresql20221026152843.csv

参数 是否必填 参数类型 说明 示例 下级对象 cycleType 是 String 订购周期类型；3 表示按月订购；5 表示按一年订购；6 表示按两年订购；7表示按三年订购 3 instanceCnt 是 Integer 订购数量；大于0且小于50 1 cycleCnt 是 Integer 订购周期，大于0，订购时长最长不能超过384个月。cycleCnt为1，cycleType为3时，表示订购1个月 1 items 是 Array 包含虚机、存储、备份三部分，由resourceType标识 List

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

本节介绍内容安全检测服务的常见问题。 购买内容安全检测服务后，多长时间能出报告？ “检测类型”选择“内容安全单次检测（按需）”时，下单后7个工作日内出报告；“检测类型”选择“文本安全监测（按月/按年）”时，下单后的检测周期（1个自然月）后的7个工作日内出报告。 购买内容安全检测服务后，什么时候扣费？ 购买内容安全检测服务后，系统立即执行检测并扣费，且检测过程中，不支持修改检测域名、暂停任务、退费等操作。 内容安全检测服务支持三种检测类型：内容安全单次检测（按需）、文本安全监测（按月）、文本安全监测（按年）。选择“内容安全单次检测（按需）”时，内容安全检测服务按“检测对象”的总个数进行收费。同一个对象再次进行扫描时，需要重新收费。 例如：单次配置了10个检测对象（新媒体账号或网站网址），每个检测对象检测一次，则需要进行10次收费。 详细的计费说明请参见计费说明。 内容安全检测服务对网站的检测范围是什么？ 内容安全检测服务可对网站/新媒体平台发布的内容进行合法合规检测，主要对文本、图片、视频、语音进行检测和识别是否包含色情、涉政、暴力、惊悚、不宜广告、垃圾信息、不良内容等，有效帮助您降低内容风险。 内容合法合规性检测 国家政策要求各地方机构要认真落实意识形态工作和网络内容安全工作责任制。为响应国家政策，内容安全检测服务可对网站/新媒体内容进行合法合规检测，主要对文本、图片、视频、语音进行检测和识别是否包含色情、涉政、暴力、惊悚、不宜广告、垃圾信息、不良内容等，有效帮助您降低内容风险。 内容准确性检测 对网站/主流新媒体平台的内容进行准确性检测，主要对文本、图片、视频、语音进行表述规范审核，如对错别字、生僻字、词法表述、语法表述等内容进行检测审核。 网站目录的检测范围： 检测同一个网站域名下的所有目录（检测的域名和网站名称完全一致）。例如， 不检测链接到其它域名的URL（检测的域名不一致）。例如，检测域名是“ 不检测链接到其它网站的URL（域名相同，但网站名称不一致的）。例如，检测域名是“

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id resId query Long 否 数据库资源唯一标识 level query String 否 日志级别,取值 ALL ERROR FATAL PANIC pageNum query Integer 否 当前页，默认1 pageSize query Integer 否 页大小，默认10，限制500 beginTime query String 否 自定义开始时间,格式：yyyyMMdd HH:mm:ss endTime query String 否 自定义结束时间,格式：yyyyMMdd HH:mm:ss hostPort query String 否 端口

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array resId Long 数据库资源唯一标识 query String 执行的语句 clientAddr String 客户端地址 clientPort String 客户端端口 dbName String 数据库名称 userName String 用户名 calls Long 调用次数 totalCost Long 总耗时,单位:ms avgCost Long 平均耗时,单位:ms minCost Long 最小耗时，单位:ms maxCost Long 最多耗时，单位:ms queryPlan String 执行计划 queryId String 执行计划唯一标识

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id mode body String 是 修改模式： cover：用ipList中的IP覆盖原白名单 delete：把ipList的IP从白名单中移除,如果有白名单中不存在的IP，会被跳过 append：把ipList中的IP加入白名单 ipList body List 是 IP列表

接口描述 修改实例的描述，描述最大长度为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说明文档查看更多错误码。

接口描述 修改Postgresql只读实例的延迟复制时间 请求方法 POST URI /v1/readonly/modifymasterslavedelay 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id nodeId body Long 是 节点id delay body Long 是 复制延迟时间，单位:ms restart body boolean 否 是否重启实例，true:重启，false:不重启，默认重启；必须重启才生效 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/readonly/modifyMasterSlaveDelay { "delay": 300, "nodeId": 2, "prodInstId": 53, "restart": true } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

方式二：批量配置防护规则 此种方式适用于域名业务较多且多个域名需要防护的策略配置相同的用户。该方式可大大减少用户相同重复的配置工作，增强防护的效率性。 入口 在左侧导航树中选择“防护策略”，进入“防护策略”页面。 操作步骤 配置防护规则。具体的操作请参见：批量添加防护规则。 WAF引擎检测机制 Web应用防火墙内置的防护规则，可帮助您防范常见的Web应用攻击，包括XSS攻击、SQL注入、爬虫检测、Webshell检测等。同时，您也可以根据自己网站防护的需要，灵活配置防护规则，Web应用防火墙根据您配置的防护规则更好的防护您的网站业务。WAF引擎内置防护规则的检测流程如图所示。 自定义防护规则的检测顺序: 1. 白名单规则 2. 地理位置访问控制规则 3. 精准访问防护规则 4. CC攻击防护规则 响应动作 ： pass：命中规则后无条件放行当前请求。 block：命中规则后拦截当前请求。 captcha：命中规则后执行人机验证动作。 redirect：命中规则后通知客户端执行重定向动作。 log：命中规则后仅记录攻击信息。 mask：命中规则后对相关敏感信息进行脱敏处理。

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

接口描述 修改实例数据库账号的描述 请求方法 PUT URI /v1/instuser/description 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 实例数据库用户名 description body String 是 修改后的账号描述 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/instuser/modifyAccountDescription { "description": "15test description", "prodInstId": 15, "username": "test" } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 检查实例下的数据库名称数据库名称是否重复或不符合命名规范 请求方法 GET URI /v1/database/nameavailable 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id dbName body String 是 数据库名称 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 enableDbName Boolean 数据库名是否可用 true:可用 false:不可用 示例 请求示例 /v1/database/checkDbNameAvailable?prodInstId1&dbNametest 响应示例 { "message": "SUCCESS", "returnObj": { "enableDbName": true }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。