ListCheckRule API Reference for Cloud Config Compliance - Security Center - Alibaba Cloud - Security Center

Queries cloud product configuration check rules.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CheckId	integer	No	The ID of the check item. Note You can call the ListCheckResult API to get the check item ID.	58
CheckName	string	No	The name of the check item.	checkName
RuleType	string	No	The rule type. Default value: WHITE. Valid values: WHITE: Add to whitelist	WHITE
ScopeType	string	No	The scope of the rule. Valid values: INSTNACE: Instance ITEM: Check item	INSTANCE
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
TaskSources	array	No	The list of task sources.
	string	No	The task source. Valid values: - YAO_CHI: Yaochi Console.	YAO_CHI

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID. You can use this ID to troubleshoot issues.	52870893-48A7-5A9E-9E05-6253E5B6****
CheckRules	array<object>	The check rules.
	array<object>
AliUid	integer	The UID of the current user.	176316827610****
Vendor	integer	The server vendor. Valid values: 0: Alibaba Cloud asset 1: Non-cloud asset 2: IDC asset 3, 4, 5, 7: Other cloud assets	0
AssetType	integer	The cloud asset type. Note For more information, see the AssetType parameter in GetCloudAssetCriteria.	1
CheckId	integer	The ID of the check item.	77
ScopeType	string	The scope of the rule. Valid values: INSTNACE: Instance ITEM: Check item	INSTANCE
RuleType	string	The rule type. Default value: WHITE. Valid values: WHITE: Add to whitelist	WHITE
RuleId	integer	The ID of the rule.	8000**
CheckShowName	string	The name of the check item.	Check for IPS Whitelist on CEN (Enterprise Edition) Tab
CheckPolicies	array<object>	The display name of the check item section.
	object	The display name of the check item's section.
sectionShowName	string	The display name of the section to which the check item belongs.	Access Control
AssetSubType	integer	The cloud asset subtype. Note For more information, see the AssetSubType parameter in GetCloudAssetCriteria.	0
VendorName	string	The name of the server provider.	ALIYUN
InstanceType	string	The cloud product asset type.	ecs
InstanceSubType	string	The cloud product asset subtype.	INSTANCE
Remark	string	The remarks.	remark
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
Count	integer	The number of entries on the current page.	10
TotalCount	integer	The total number of entries.	10

Examples

Success response

JSON format

{
  "RequestId": "52870893-48A7-5A9E-9E05-6253E5B6****",
  "CheckRules": [
    {
      "AliUid": 0,
      "Vendor": 0,
      "AssetType": 1,
      "CheckId": 77,
      "ScopeType": "INSTANCE",
      "RuleType": "WHITE",
      "RuleId": 0,
      "CheckShowName": "Check for IPS Whitelist on CEN (Enterprise Edition) Tab",
      "CheckPolicies": [
        {
          "sectionShowName": "Access Control"
        }
      ],
      "AssetSubType": 0,
      "VendorName": "ALIYUN",
      "InstanceType": "ecs",
      "InstanceSubType": "INSTANCE",
      "Remark": "remark"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "Count": 10,
    "TotalCount": 10
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.