All Products
Search
Document Center

PolarDB:DescribeMaskingRules

Last Updated:May 29, 2025

Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeMaskingRulesget
*DBCluster
acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.
pc-*****************
RuleNameListstringNo

The name of the masking rule.

testrule
InterfaceVersionstringNo

Queries data masking rules or encryption rules. Valid values:

v1: queries data masking rules. v2: queries data encryption rules.

v1

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

2F83D131-1C18-4599-889D-729A9D******
Messagestring

The message that is returned for the request.

Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.
Successful
Successboolean

Indicates whether the request is successful. Valid value:

  • true
  • false
true
Dataobject

The result data that is returned.

RuleListarray

Details about the masking rules.

RuleListstring

The detailed configurations of the masking rule.

Note For more information, see the RuleConfig parameter in the ModifyMaskingRules operation.
"{\"testrule\":{\"auto\":{\"databases\":[],\"tables\":[\"t1\"],\"columns\":[\"c1\"]},\"applies_to\":[],\"description\":\"This rule will be applied to the columns c1 in table t1\",\"enabled\":\"true\"}}"
RuleVersionstring

The version of the masking rule. Valid values: v1 and v2. Default value: v1

v1
DBClusterIdstring

The ID of the cluster.

pc-bp1s826a1up******

Examples

Sample success responses

JSONformat

{
  "RequestId": "2F83D131-1C18-4599-889D-729A9D******",
  "Message": "Successful",
  "Success": true,
  "Data": {
    "RuleList": [
      {
        "testrule": {
          "auto": {
            "databases": [],
            "tables": [
              "t1"
            ],
            "columns": [
              "c1"
            ]
          },
          "applies_to": [],
          "description": "This rule will be applied to the columns c1 in table t1",
          "enabled": true
        }
      }
    ],
    "RuleVersion": "v1"
  },
  "DBClusterId": "pc-bp1s826a1up******"
}

Error codes

HTTP status codeError codeError messageDescription
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-02The Error code has changed. The response structure of the API has changedView Change Details
2023-09-12The Error code has changedView Change Details