全部产品
Search
文档中心

云原生数据库 PolarDB:CheckSqlAuditSlsStatus - 校验审计状态

更新时间:Sep 10, 2026

该接口用于检查指定数据库实例的 SQL 审计日志是否已成功接入 SLS(阿里云日志服务,Log Service)。 调用后,系统返回当前实例的 SQL 审计功能与 SLS 的连接状态、项目(Project)和日志库(Logstore)配置信息、同步是否正常等。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:CheckSqlAuditSlsStatus

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

实例所在地域。>您可以调用 describeregions 接口查看 polardb-x 支持的地域详情,包括地域 id。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Status

string

sql 审计功能开启状态,取值范围如下:enabled:已开启disabled:未开启

enabled

RequestId

string

请求 id。

173CA69A-3513-591D-8A09-C1EA37CBE2D9

示例

正常返回示例

JSON格式

{
  "Status": "enabled",
  "RequestId": "173CA69A-3513-591D-8A09-C1EA37CBE2D9"
}

错误码

HTTP status code

错误码

错误信息

描述

404 InvalidDBInstance.NotFound The specified DB instance does not exist. 数据库实例不存在

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

变更历史

更多信息,参考变更详情