All Products
Search

This Product

    Data Security Center:CreateRule

    Document Center

    Data Security Center:CreateRule

    Last Updated:Nov 27, 2025

    Call CreateRule to create a custom sensitive data detection rule.

    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

    yundun-sddp:CreateRule

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    Yes

    The name of the sensitive data detection rule.

    rule-tst
    Category

    integer

    No

    The content type of the sensitive data detection rule. Valid values:

    • 0: keyword.

    • 2: regular expression.

    0
    Content

    string

    Yes

    The content of the sensitive data detection rule. The content can be a regular expression or a keyword that is used to match sensitive data fields or text.

    (?:\\D|^)((?:(?:25[0-4]|2[0-4]\\d|1\\d{2}|[1-9]\\d{1})\\.)(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d?\\d)\\.){2}(?:25[0-5]|2[0-4]\\d|1[0-9]\\d|[1-9]\\d|[1-9]))(?:\\D|$)
    StatExpress

    string

    No

    The statistical expression.

    {"time":"24","groupby":"1003","having":[{"key":"2001","value":"50"}]}
    RiskLevelId

    integer

    No

    The sensitivity level ID of the sensitive data detection rule. Valid values:

    • 1: N/A. No sensitive data is detected.

    • 2: S1. Level 1 sensitive data.

    • 3: S2. Level 2 sensitive data.

    • 4: S3. Level 3 sensitive data.

    • 5: S4. Level 4 sensitive data.

    2
    RuleType

    integer

    No

    The type of the rule. Valid values:

    • 1: data detection rule.

    • 2: audit policy.

    • 3: anomaly detection rule.

    • 99: custom rule.

    1
    ProductCode

    string

    No

    The name of the service to which the data asset belongs. Valid values: MaxCompute, OSS, ADS, OTS, and RDS.

    RDS
    ProductId

    integer

    No

    The ID of the service to which the data asset belongs. Valid values:

    • 1: MaxCompute

    • 2: OSS

    • 3: ADS

    • 4: OTS

    • 5: RDS

    • 6: SELF_DB

    2
    WarnLevel

    integer

    No

    The risk level. Valid values:

    • 1: Low.

    • 2: Medium.

    • 3: High.

    2
    Description

    string

    No

    The description of the rule.

    身份证
    ContentCategory

    integer

    No

    The content type. Valid values:

    • 1: SQL injection exploit.

    • 2: SQL injection bypass.

    • 3: stored procedure abuse.

    • 4: buffer overflow.

    • 5: error-based SQL injection.

    1
    Status

    integer

    No

    The status of the rule. Valid values:

    • 1: Enabled.

    • 0: Disabled.

    1
    Target

    string

    No

    The code of the service to which the rule applies. Valid values: MaxCompute, OSS, ADS, OTS, and RDS.

    MaxCompute
    MatchType

    integer

    No

    The match type. Valid values:

    • 1: rule-based match.

    • 2: dictionary-based match.

    1
    SupportForm

    integer

    No

    The type of data assets that the rule supports. Valid values:

    • 0: all assets.

    • 1: structured assets.

    • 2: unstructured assets.

    1
    SourceIp

    string

    No

    This parameter is deprecated.

    106.11.XX.XX
    TemplateRuleIds

    string

    No

    The IDs of the template rules for sensitive data auditing.

    1
    ModelRuleIds

    string

    No

    The IDs of the model rules for sensitive data auditing.

    1452
    Lang

    string

    No

    The language of the content in the request and response. Valid values:

    • zh: Chinese.

    • en: English.

    zh

    Response elements

    Element

    Type

    Description

    Example

    object

    Id

    integer

    The unique ID of the sensitive data detection rule.

    1
    RequestId

    string

    The ID of the request.

    208B016D-4CB9-4A85-96A5-0B8ED1EBF271

    Examples

    Success response

    JSON format

    {
  "Id": 1,
  "RequestId": "208B016D-4CB9-4A85-96A5-0B8ED1EBF271"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.