All Products
Search

This Product

    PolarDB:DescribePolarSQLCollectorPolicy

    Document Center

    PolarDB:DescribePolarSQLCollectorPolicy

    Last Updated:Dec 11, 2025

    Checks whether the SQL Explorer feature is enabled for a target cluster.

    Operation description

    Note: This API operation is deprecated. Use Query the configurations of DAS Enterprise Edition instead.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DescribePolarSQLCollectorPolicy

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The ID of the cluster.

    Note

    Call the DescribeDBClusters operation to query the details of all clusters in your account. The details include the cluster ID.

    pc-****************

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

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

    string

    Indicates whether the SQL Explorer feature is enabled. Valid values:

    • Enable: The feature is enabled.

    • Disabled: The feature is disabled.

    Enable
    DBClusterId

    string

    The ID of the cluster.

    pc-bp1s826a1up******

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.