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

接口描述 修改SQL洞察日志保存时长。 接口约束 实例需要已开启SQL洞察 URI PUT /v1/collector/sqlcollectorretention 请求参数 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 retainValue 是 Integer SQL洞察日志保存时长，单位：天，取值：30，180，365，1095，1825 30 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 请求示例 /v1/collector/sqlcollectorretention 请求体body { "prodInstId": 10, "retainValue": 30 } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array resId Integer 数据库资源唯一标识 databaseName String 数据库名称 querySql String 查询的语句 userName String 用户名 clientAddress String 客户端ip clientPort Integer 客户端端口 queryStart String 查询开始时间 queryEnd String 查询结束时间 queryPlan String 查询计划 queryCost Integer 耗时，单位:ms

接口描述 查询PostgreSQL实例支持的字符集 请求方法 GET URI /v1/database/charactersetname 请求参数 名称 位置 类型 必选 说明 engine query String 是 数据库引擎类型。取值： postgreSQL：PostgreSQL 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 characterSetNameItems List 支持的字符集列表,例如： ["gbk","utf8","ascii"] engine String 数据库引擎类型。取值： postgreSQL：PostgreSQL 示例 请求示例 /v1/database/getCharacterSetName?enginepostgreSQL 响应示例 { "message": "SUCCESS", "returnObj": { "characterSetNameItems": [ "utf8", "gbk", "ascii" ], "engine": "postgreSQL" }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 查询RDS实例的SQL洞察（SQL审计）日志 接口约束 URI GET /v1/collector/sqllogrecords 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 pageNum 是 Integer 页码最小值为1 1 pageSize 是 Integer 页大小取值范围为：1500 10 dbName 否 String 数据库名称。默认为所有数据库，也可以输入数据库名称查询，一次只能输入一个 test accountName 否 String 用户名称。默认为所有用户，也可以输入用户名称查询，一次只能输入一个 root startTime 是 String 查询开始时间,格式：yyyyMMdd HH:mm:ss endTime 是 String 查询结束时间,大于查询开始时间，与查询开始时间间隔小于等于30天,格式：yyyyMMdd HH:mm:ss queryKeywords 否 List 用于查询的关键字,​ 1.多个关键字以空格分隔，不超过10个关键字​ 2.如果SQL语句中的字段名使用了反引号（），以该字段名作为查询的关键字时，也需要输入反引号。例如，字段名为id，则输入id，而不是id SELECT 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj PageVO 返回对象 PageVO 参数 参数类型 说明 示例 下级对象 pageNum Integer 页码 1 pageSize Integer 页大小 10 pageTotal Integer 总页数 1 total Integer 总记录数 2 list List 记录 DescribeSQLLogRecordsVO DescribeSQLLogRecordsVO 参数 参数类型 说明 示例 下级对象 hostAddress String 连接数据库的客户端IP地址 192.168.0.18:50744 sqlText String SQL语句 terminating connection due to administrator command dbName String 数据库名称 postgres executeTime Long 执行时间 1667354445000 threadId String 线程id 6952 accountName String 执行操作的账号名称 test

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 prodInstId Long 实例id dbName String 数据库名称 dbEncoding String 字符集 dbCollate String 字符串排序规则 dbCtype String 字符分类 dbOwner String 数据库所有者 createTimestamp Long 创建时间 updateTimestamp Long 更新时间 dbDescription String 数据库描述

接口功能介绍 修改实例的root账户密码 接口约束 实例必须处于运行中的状态 URI PUT /v1/remote/rootpassword 请求参数 body参数 参数 是否必填 参数类型 说明 示例 prodInstId 是 Integer 实例id 54 newPassword 是 String 新密码。816位，且必须含有数字，小写字母，大写字母，特殊字符 Arcyd12EQR 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] 请求示例 /v1/remote/rootpassword 请求参数 json { "prodInstId":54, "newPassword":"Arcyd12EQR" } 响应示例 json { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 示例 请求示例 {URI}?/v1/instuser/hbaconfig { "prodInstId":34, "opType":"modify", "line":10, "items":{ "type":"host", "username":"test,usertest", "database":"test,test2" } } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array recoveryEndTime Long 备份可恢复的终止时间 recoveryBeginTime Long 备份可恢复的起始时间 prodInstId Long 实例id backupId Long 备份id backupName String 备份名称

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

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

接口描述 查询SQL洞察（SQL审计）状态。 实例必须为运行状态. 请求方法 GET URI /v1/collector/sqlcollectorpolicy 请求参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 List DescribeSQLCollectorPolicyVO 参数 参数类型 说明 示例 下级对象 host String 数据库ip 192.168.1.11 port Integer 数据库端口 5432 sqlCollectorStatus String SQL审计状态，取值：enable disabled disabled 示例 请求示例 /v1/collector/sqlcollectorpolicy?prodInstId10 响应示例 { "message": "SUCCESS", "returnObj": [ { "host": "192.168.1.11", "port": 5200, "sqlCollectorStatus": "disabled" }, { "host": "192.168.1.12", "port": 5200, "sqlCollectorStatus": "disabled" } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

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

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

名称 二级节点 三级节点 位置 类型 必选 说明 labelInfos body Array 是 标签信息列表，最大长度为50 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 否 标签列表,一次最多20个 labelName body String 是 标签名称，若传递，则不能为空字符串或者null labelValue body String 否 标签值

接口功能介绍 下载实例参数配置。 接口约束 URI GET /v1/params/downloadparam 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 setName 是 String 实例参数配置名称 实例10的参数配置 响应参数 请求成功时，返回的是一个文件流，在浏览器可以直接下载 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象 请求示例 /v1/params/downloadparam?prodInstId10&setName实例10的参数配置 请求头header 请求体body 响应示例 json { "message": "请求失败 : 实例参数配置名称不能为空", "returnObj": {}, "statusCode": 810 } 错误码 访问ErrorCodes说明文档查看更多错误码。

步骤二：下载检测报告 步骤 1 在左侧导航栏选择“高阶功能> 内容安全检测”，进入“内容安全检测”页面。 步骤 2 在目标检测对象所在行的“操作”列，单击“下载报告”，可将检测报告下载到本地。 报告中呈现检测出的合规性风险、内容安全风险等相关内容。用户根据报告内容选择整改或者保留。 “检测状态”为“检测完成”时，才支持下载报告。检测状态为“检测中”，不支持下载报告，图中的检测状态为“检测中”，不支持下载报告，下载报告按钮不可点击。 其他操作 如果您需要对检测对象进行再次检测时，在该检测对象所在行的“操作”列，单击“复购”。

接口描述 查询指定的Postgresql参数模板信息。 请求方法 GET URI /v1/template/list 请求参数 名称 位置 类型 必选 说明 templateId query Long 是 参数模板ID name query String 否 参数名称 prodInstId query Long 是 实例id 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array paramName String 参数名 paramValue String 参数值 permitValue String 允许的值 desc String 简单描述 description String 描述 valueType String 参数类型 restart String 是否需要重启生效,0:否，1是 示例 请求示例 /v1/template/list?templateId1&prodInstId53 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ { "description": "设置用于对WAL文件进行归档的shell命令。", "paramName": "archivecommand", "paramValue": "''", "permitValue": "", "restart": "0", "valueType": "string" } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

本章节主要介绍WAF权限及授权项。 如果您需要对您所拥有的WAF进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，IAM），如果登录账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用WAF服务的其它功能。 默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使用户组中的用户获得相应的权限，这一过程称为授权。授权后，用户就可以基于已有权限对云服务进行操作。 权限根据授权的精细程度，分为角色和策略。角色以服务为粒度，是IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。策略授权更加精细，可以精确到某个操作、资源和条件，能够满足企业对权限最小化的安全管控要求。 支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。 权限：允许或拒绝某项操作。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 权限 授权项 :: 查询防敏感信息泄漏规则 waf:antiLeakageRule:get 查询网页防篡改规则 waf:antiTamperRule:get 查询CC攻击防护规则 waf:ccRule:get 查询精准访问防护规则 waf:preciseProtectionRule:get 查询误报屏蔽规则 waf:falseAlarmMaskRule:get 查询隐私屏蔽规则 waf:privacyRule:get 查询黑白名单规则 waf:whiteBlackIpRule:get 查询地址位置访问控制规则 waf:geoIpRule:get 查询证书 waf:certificate:get 修改WAF证书 waf:certificate:put 查询防护事件 waf:event:get 查询防护域名 waf:instance:get 查询防护策略 waf:policy:get 查询用户套餐信息 waf:bundle:get 查询防护事件下载链接 waf:dumpEventLink:get 查询页面配置信息 waf:consoleConfig:get 查询回源IP段 waf:sourceIp:get 更新防敏感信息泄漏规则 waf:antiLeakageRule:put 更新网页防篡改规则 waf:antiTamperRule:put 更新CC攻击防护规则 waf:ccRuleRule:put 更新精准访问防护规则 waf:preciseProtectionRule:put 更新误报屏蔽规则 waf:falseAlarmMaskRule:put 更新隐私屏蔽规则 waf:privacyRule:put 更新黑白名单规则 waf:whiteBlackIpRule:put 更新地址位置访问控制规则 waf:geoIpRule:put 更新防护域名 waf:instance:put 更新防护策略 waf:policy:put 删除防敏感信息泄漏规则 waf:antiLeakageRule:delete 删除网页防篡改规则 waf:antiTamperRule:delete 删除CC攻击防护规则 waf:ccRule:delete 删除精准访问防护规则 waf:preciseProtectionRule:delete 删除误报屏蔽规则 waf:falseAlarmMaskRule:delete 删除隐私屏蔽规则 waf:privacyRule:delete 删除黑白名单规则 waf:whiteBlackIpRule:delete 删除地址位置访问控制规则 waf:geoIpRule:delete 删除防护域名 waf:instance:delete 删除防护策略 waf:policy:delete 创建防敏感信息泄漏规则 waf:antiLeakageRule:create 创建网页防篡改规则 waf:antiTamperRule:create 创建CC攻击防护规则 waf:ccRule:create 创建精准访问防护规则 waf:preciseProtectionRule:create 创建误报屏蔽规则 waf:falseAlarmMaskRule:create 创建隐私屏蔽规则 waf:privacyRule:create 创建黑白名单规则 waf:whiteBlackIpRule:create 创建地址位置访问控制规则 waf:geoIpRule:create 创建证书 waf:certificate:create 创建防护域名 waf:instance:create 创建防护策略 waf:policy:create 查询防敏感信息泄漏规则列表 waf:antiLeakageRule:list 查询网页防篡改规则列表 waf:antiTamperRule:list 查询CC攻击防护规则列表 waf:ccRuleRule:list 查询精准访问防护规则列表 waf:preciseProtectionRule:list 查询误报屏蔽规则列表 waf:falseAlarmMaskRule:list 查询隐私屏蔽规则列表 waf:privacyRule:list 查询黑白名单规则列表 waf:whiteBlackIpRule:list 查询地址位置访问控制规则列表 waf:geoIpRule:list 查询防护域名列表 waf:instance:list 查询防护策略列表 waf:policy:list 查询独享引擎实例列表 waf:premiumInstance:list 查询独享引擎 waf:premiumInstance:get 创建独享引擎实例 waf:premiumInstance:create 删除独享引擎实例 waf:premiumInstance:delete 更新独享引擎 waf:premiumInstance:put

接口描述 查询Postgresql实例数据加密状态。 请求方法 GET URI /v1/product/encryption 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Boolean true:已加密 false:未加密 示例 请求示例 /v1/product/getProductEncryption?prodInstId53 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": false, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 delayTime String 复制延迟时间

接口描述 查询Postgresql实例在指定时间范围内的增强指标监控信息 请求方法 GET URI /v1/monitor/queryenhancedmetrics 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 自定义查询开始时间,格式：yyyyMMdd HH:mm:ss endTime query String 是 自定义查询结束时间,格式：yyyyMMdd HH:mm:ss,查询时间间隔不超过30天 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id nodes List 实例各个节点性能信息 ip String 节点ip master boolean 是否主节点 metrics List > 时间范围内各个时间点已开启的增强性能指标 示例 请求示例 /v1/monitor/queryInstEnhancedMetrics?prodInstId14&startTime20220820 19:18:41&endTime20220820 19:19:42 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "instId": 53, "nodes": [ { "ip": "192.168.190.11", "master": true, "metrics": [ { "collectTime": "20220908 17:45:01", "con": 0, "delay": 0, "walsize": 0.00 }, { "collectTime": "20220908 17:46:01", "con": 6, "delay": 0, "walsize": 11.00 }, { "collectTime": "20220908 17:47:01", "con": 5, "delay": 0, "walsize": 11.00 } ] }, { "ip": "192.168.190.12", "master": false, "metrics": [] } ] }, "statusCode": 800 }

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

示例 请求示例 /v1/monitor/pageSwitchRecord?prodInstId1&satrtTime2022722 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "list": [ { "createTime": 1661694462000, "curSetRun": "192.168.1.116543192.168.1.126543", "oldSetRun": "192.168.1.126543192.168.1.116543", "prodInstId": 53, "prodInstName": "set11126563", "result": true, "switchTime": 1661711492000, "switchType": "auto" } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 2 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 enableEventLog Boolean 历史事件开启情况 true：开启 false：关闭

名称 位置 类型 必选 说明 pageNum query Integer 是 页码 pageSize query Integer 是 页大小，范围1500 startTime query Long 否 自定义查询开始时间,格式:时间戳 endTime query Long 否 自定义查询结束时间,格式:时间戳

示例 请求示例 /v1/monitor/getPerformance?prodInstId14&startTime'20220819 00:00:00'&endTime'20220820 23:59:00' 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "instId": 14, "nodes": [ { "ip": "192.168.190.11", "master": false, "metrics": [ { "collectTime": "20220820 15:54:48", "cpuSys": 3, "cpuUser": 1, "ioUtil": 0.1, "qps": 0, "rRateKbs": 6.2, "tps": 0, "wRateKbs": 74.5 }, { "collectTime": "20220820 15:54:48", "cpuSys": 3, "cpuUser": 1, "ioUtil": 0.1, "qps": 0, "rRateKbs": 6.2, "tps": 0, "wRateKbs": 74.5 } ] }, { "ip": "192.168.190.12", "master": true, "metrics": [] } ] }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

接口描述 将历史数据恢复至一个新实例（称为克隆实例） 请求方法 POST URI /v1/recover/cloneinstance 请求参数 名称 位置 类型 必选 说明 srcProdInstId body Long 是 源pg实例id backupId body Long 否 备份id,和restoreTime只能有一个为空 destProdInstId body Long 是 目标实例id restoreTime body String 否 备份保留周期内的任意时间点。格式：yyyyMMdd HH:mm:ss 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/recover/cloneInstance { "backupId": 1, "destProdInstId": 7, "restoreTime": "", "srcProdInstId": 6 } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {} } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

名称 位置 类型 必选 说明 srcProdInstId body Long 是 源PG的实例ID destProdInstId body Long 是 目标PG的实例ID backupName body String 是 备份名称