All Products
Search
Document Center

PolarDB:DescribeMaskingRules

最終更新日:Jul 01, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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

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.

string

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