Tüm Ürünler
Search
Belge Merkezi

:DescribeMaskingRules

Son Güncelleme:Sep 30, 2026

Bir PolarDB kümesinin veri maskeleme kurallarını veya belirtilen bir maskeleme kuralı hakkındaki bilgileri sorgular.

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:DescribeMaskingRules

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

None None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

Kümenin kimliği.

Not

Alibaba Cloud hesabınıza ait kümelerin kimlikleri gibi ayrıntılarını sorgulamak için DescribeDBClusters işlemini çağırabilirsiniz.

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

RuleNameList

string

No

Maskeleme kuralının adı.

testrule

InterfaceVersion

string

No

Veri maskeleme kurallarını veya şifreleme kurallarını sorgular. Geçerli değerler:

v1: Veri maskeleme kurallarını sorgular. v2: Veri şifreleme kurallarını sorgular.

v1

Response elements

Element

Type

Description

Example

object

Yanıt şeması.

RequestId

string

İsteğin kimliği.

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

Message

string

İstek için döndürülen ileti.

Not

İstek başarılıysa Successful döndürülür. İstek başarısız olursa, hata kodu gibi bir hata iletisi döndürülür.

Successful

Success

boolean

İsteğin başarılı olup olmadığını gösterir. Geçerli değerler:

  • true

  • false

true

Data

object

Döndürülen sonuç verileri.

RuleList

array

Maskeleme kuralları hakkındaki ayrıntılar.

string

Maskeleme kuralının ayrıntılı yapılandırmaları.

Not

Daha fazla bilgi için ModifyMaskingRules işlemindeki RuleConfig parametresine bakın.

"{\"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

string

Maskeleme kuralının sürümü. Geçerli değerler: v1 ve v2. Varsayılan değer: v1.

v1

DBClusterId

string

Kümenin kimliği.

pc-bp1s826a1up******

Examples

Success response

JSON format

{
  "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 code

Error code

Error message

Description

400 Abs.InvalidAccount.NotFound account is not found.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.