调用EnableSqlAudit接口开启SQL审计功能。

说明
  • PolarDB-X 2.0 SQL审计与分析功能本身免费使用,但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费,更多关于SQL审计功能的详情,请参见开启SQL审计与分析

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String EnableSqlAudit

系统规定参数。取值:EnableSqlAudit。

AuditAccountName String test_daa

审计管理员账号名称。

说明 若已开启三权分立模式,该参数必填。更多关于三权分立模式的信息,请参见三权分立
DBInstanceId String pxc-****************

实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有实例的详情,包括实例ID。
RegionId String cn-hangzhou

实例所在地域ID。

说明 您可以调用DescribeRegions接口查看PolarDB-X支持的地域详情,包括地域ID。
ExpireAfterDays Integer 45

SQL审计日志的存储时长。默认保存45天。

AuditAccountPassword String Pw@11111

审计管理员账号的密码。

说明 若已开启三权分立模式,该参数必填。更多关于三权分立模式的信息,请参见三权分立

返回数据

名称 类型 示例值 描述
RequestId String DC3ABA3E-0F8A-4596-9104-F5167C******

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=EnableSqlAudit
&AuditAccountName=test_daa
&DBInstanceId=pxc-****************
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<RequestId>DC3ABA3E-0F8A-4596-9104-F5167C******</RequestId>
<Success>true</Success>

JSON格式

{
    "RequestId": "DC3ABA3E-0F8A-4596-9104-F5167C******",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBInstance.NotFound The specified DB instance does not exist. 数据库实例不存在

访问错误中心查看更多错误码。