Query automatic configuration check settings using GetCheckConfig - Security Center - Alibaba Cloud - Security Center

Retrieves the check item configurations for cloud platform configuration checks.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceDirectoryAccountId	integer	No	The ID of the China account in the resource folder for member accounts. Note Invoke the DescribeMonitorAccounts operation to obtain this parameter.

Response elements

Element	Type	Description	Example
	object	GetCheckConfigResponse
CycleDays	array	The periodic check schedule.
	integer	The day of the week on which the periodic check runs. The value indicates the day of the week.	[1, 2, 3, 4, 5]
StartTime	integer	The start time of the check period, indicating the hour of the day. Unit: hours (h).	0
EndTime	integer	The end time of the check period, indicating the hour of the day. The start time and end time must fall within one of the following time ranges: 0~6: If the start time is 0, the end time must be set to 6. 6~12: If the start time is 6, the end time must be set to 12. 12~18: If the start time is 12, the end time must be set to 18. 18~24: If the start time is 18, the end time must be set to 24. Unit: hours (h).	6
Standards	array<object>	The list of check item information.
	object	The check item information.
Id	integer	The ID of the check item.	1
ShowName	string	The name of the check item.	Cloud Product Configuration Management
Type	string	The type of the check item. Valid values: RISK: Cloud product configuration management. IDENTITY_PERMISSION: Identity and permission management. COMPLIANCE: Compliance.	RISK
Status	string	The enabling status of the check item. Valid values: ON: Enabled. OFF: Shutdown.	ON
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	5A3D5C8F-2A42-5477-BDD8-27E64B5F1739
EnableAutoCheck	boolean	Indicates whether automatic periodic checks are enabled. Valid values: true: Enabled. false: Disabled.	true
EnableAddCheck	boolean	Indicates whether new check items added to the selected standards are checked by default. Valid values: true: Enabled. false: Disabled.	false
SelectedChecks	array<object>	The check items selected in the policy.
	object
CheckId	integer	The ID of the check item.	3
SectionId	integer	The section ID of the check item.	69

Examples

Success response

JSON format

{
  "CycleDays": [
    0
  ],
  "StartTime": 0,
  "EndTime": 6,
  "Standards": [
    {
      "Id": 1,
      "ShowName": "云产品配置管理",
      "Type": "RISK",
      "Status": "ON"
    }
  ],
  "RequestId": "5A3D5C8F-2A42-5477-BDD8-27E64B5F1739",
  "EnableAutoCheck": true,
  "EnableAddCheck": false,
  "SelectedChecks": [
    {
      "CheckId": 3,
      "SectionId": 69
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam	Illegal param
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
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.