DescribeCategoryTemplateRuleList - Data Security Center - Alibaba Cloud Documentation Center

Queries a paginated list of rules in a data classification template.

Operation description

You can call this operation to query the list of rules in a data classification template. This helps you understand the details of the rules in the template.

QPS limit

The queries per second (QPS) limit for a single user on this operation is 10 calls per second. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Simplified Chinese. en_us: US English.	zh_cn
PageSize	integer	No	The number of template rules to return on each page. The default value is 10.	10
CurrentPage	integer	No	The page number. The default value is 1.	1
Status	integer	No	The status of the template rule. The default value is null. Valid values: 0: The rule is disabled. 1: The rule is enabled. null: All rules are returned, regardless of their status.	1
RiskLevelId	integer	No	The risk level of the template rule. The value ranges from 1 to 11. The default value is null. Valid values: 1: No risk. 2: S1. 3: S2. 4: S3. 5: S4. 6: S5. 7: S6. 8: S7. 9: S8. 10: S9. 11: S10. null: All risk levels, including No risk, S1, S2, S3, S4, S5, S6, S7, S8, S9, and S10.	2
FeatureType	integer	No	This parameter is deprecated.	1

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number.	1
RequestId	string	The ID of the request.	136082B3-B21F-5E9D-B68E-991FFD205D24
PageSize	integer	The number of template rules returned on each page.	10
TotalCount	integer	The total number of rules in the template.	10
Items	array<object>	A list of template rules.
	object
Status	integer	The status of the template rule. Valid values: 0: disabled. 1: enabled. null: Represents all statuses, including enabled and disabled.	1
IdentificationScope	string	The scope of data that the template rule scans. This parameter is a string converted from a JSON array. Each element in the JSON array represents a data scanning scope and contains the following fields: Asset: A string that indicates the asset type. Valid values include RDS, DRDS, PolarDB, OTS, ADB, OceanBase, and ODPS. Content: The specific scope of the asset to scan. This is an array of objects, where each object contains the following fields: Range: A string that indicates the matching range. Valid values include instance, database, table, column, project (for MaxCompute assets only), bucket (for OSS assets only), and object (for OSS assets only). Operator: A string that indicates the matching condition. Valid values include equals, regex (regular expression), prefix, and suffix. Value: A string that indicates the content to match.	[{"Asset":"RDS","Content":[{"Range":"database","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"project","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]}]
RiskLevelId	integer	The risk level of the template rule. The value ranges from 1 to 11. Valid values: 1: No risk. 2: S1. 3: S2. 4: S3. 5: S4. 6: S5. 7: S6. 8: S7. 9: S8. 10: S9. 11: S10. null: Indicates all risk levels, including No risk, S1, S2, S3, S4, S5, S6, S7, S8, S9, and S10.	2
Description	string	The description of the rule.	用于识别身份证号的模板规则
IdentificationRuleIds	string	A comma-separated list of IDs of the associated atomic models.	1001,1002
Name	string	The name of the template rule.	身份证号
Id	integer	The unique ID of the template rule.	100

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "136082B3-B21F-5E9D-B68E-991FFD205D24",
  "PageSize": 10,
  "TotalCount": 10,
  "Items": [
    {
      "Status": 1,
      "IdentificationScope": "[{\"Asset\":\"RDS\",\"Content\":[{\"Range\":\"database\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"RDS\",\"Content\":[{\"Range\":\"table\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"RDS\",\"Content\":[{\"Range\":\"column\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"ODPS\",\"Content\":[{\"Range\":\"project\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"ODPS\",\"Content\":[{\"Range\":\"table\",\"Operator\":\"regex\",\"Value\":\"register\"}]},{\"Asset\":\"ODPS\",\"Content\":[{\"Range\":\"column\",\"Operator\":\"regex\",\"Value\":\"register\"}]}]",
      "RiskLevelId": 2,
      "Description": "用于识别身份证号的模板规则",
      "IdentificationRuleIds": "1001,1002",
      "Name": "身份证号",
      "Id": 100
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.