DescribeSqlAuditInfo - 查看SQL审计信息 - 云原生数据库 PolarDB

接口说明

说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeSqlAuditInfo

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域 id>您可以调用 describeregions 查看 polardb-x 支持的地域详情，包括地域 id。	cn-hangzhou
DBInstanceId	string	是	实例 id。>您可以调用 describedbinstances 接口查看目标地域下所有实例的详情，包括实例 id。	pxc-****************
AuditAccountName	string	否	审计管理员账号名称。>若已开启三权分立模式，该参数必填。详情请参见三权分立。	test_daa
AuditAccountPassword	string	否	审计管理员账号的密码。>若已开启三权分立模式，该参数必填。更多关于三权分立模块的信息，请参见三权分立。	******

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 id。	DC3ABA3E-0F8A-4596-9104-F5155C******
Data	object	返回结果集。
SLSLogStore	string	sls 的 logstore 名称。	polardbx-sqlaudit-log
SLSProject	string	slsproject 的名称。	polardbx-sqlaudit-cn-hangzhou-1852045029120897
IsEnabled	boolean	sql 审计功能是否开启。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "DC3ABA3E-0F8A-4596-9104-F5155C******",
  "Data": {
    "SLSLogStore": "polardbx-sqlaudit-log",
    "SLSProject": "polardbx-sqlaudit-cn-hangzhou-1852045029120897",
    "IsEnabled": true
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。