全部产品
Search
文档中心

云原生数据库 PolarDB:DescribePolarSQLCollectorPolicy - 查询集群SQL洞察功能

更新时间:Jun 17, 2024

查看目标集群的SQL洞察功能是否已开启。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribePolarSQLCollectorPolicyRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

说明 您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息(如集群 ID)。
pc-****************

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

3655211B-4D74-4E13-91E6-FF2AFE******
SQLCollectorStatusstring

SQL 洞察功能是否开启,取值范围如下:

  • Enable:已开启
  • Disabled:未开启
Enable
DBClusterIdstring

集群 ID。

pc-bp1s826a1up******

示例

正常返回示例

JSON格式

{
  "RequestId": "3655211B-4D74-4E13-91E6-FF2AFE******",
  "SQLCollectorStatus": "Enable",
  "DBClusterId": "pc-bp1s826a1up******"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-12API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用