Query sensitive file check rules using GetSensitiveDefineRuleConfig - Security Center - Alibaba Cloud - Security Center

Queries custom check items for sensitive file tampering.

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-sas:GetSensitiveDefineRuleConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh
Source	string	No	The source of the sensitive file check item. Valid values: image: image agentless: agentless.	image

Response elements

Element	Type	Description	Example
	object	The response.
Data	object	The returned data details.
Id	integer	The custom configuration ID.	44616
RuleCount	integer	The total number of check items.	100
SelectedCount	integer	The number of selected check items.	99
RuleTree	array<object>	The check item rule tree.
	array<object>	The check item.
ClassKey	string	The category keyword of the check rule.	password
ClassName	string	The category name of the check rule.	password
RuleList	array<object>	The list of check rules.
	object
RuleKey	string	The keyword of the check rule.	huaweicloud_ak
RuleName	string	The name of the check rule.	huaweicloud_ak
Selected	boolean	Indicates whether the check rule is selected. Valid values: true false	true
EnableNewRule	integer	Indicates whether automatic check is enabled for new rules. This parameter takes effect only for agentless checks. Valid values: 0: Disabled. 1: Enabled.	0
Success	boolean	Indicates whether the query was successful. Valid values: true: Successful. false: Failed.	true
Code	string	The status code returned by the API request.	200
Message	string	The message returned for the request.	successful
RequestId	string	The request ID.	7E0618A9-D5EF-4220-9471-C42B5E92****

Examples

Success response

JSON format

{
  "Data": {
    "Id": 44616,
    "RuleCount": 100,
    "SelectedCount": 99,
    "RuleTree": [
      {
        "ClassKey": "password",
        "ClassName": "password",
        "RuleList": [
          {
            "RuleKey": "huaweicloud_ak",
            "RuleName": "huaweicloud_ak",
            "Selected": true
          }
        ]
      }
    ],
    "EnableNewRule": 0
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.