GetCheckStructure API Reference for Configuration Assessment - Security Center - Alibaba Cloud - Security Center

Queries the directory structure of the check item list.

Operation description

The cloud platform configuration check feature requires a purchase before use.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The page number of the current page in a paging query.	1
PageSize	integer	No	The maximum number of entries per page in a paging query.	20
Lang	string	No	The language type for requests and responses. Default value: zh. Valid values: zh: Chinese en: English.	zh
RegionId	string	No	The region where the asset resides. Valid values: cn-hangzhou: China ap-southeast-1: outside China.	cn-hangzhou
TaskSources	array	No	The list of task sources.
	string	No	The task source. Valid values: YAO_CHI: ApsaraDB.	YAO_CHI

Response elements

Element	Type	Description	Example
	object	LGetCheckStructureResponse
CheckStructureResponse	array<object>	The structure information of cloud platform configuration check items.
	array<object>
StandardType	string	The business type of the cloud platform configuration check item. Valid values: RISK: security risk IDENTITY_PERMISSION: permission management CIEM COMPLIANCE: security compliance.	RISK
Standards	array<object>	The structure information of check items under the business type.
	array<object>
Requirements	array<object>	The standards of the check items.
	array<object>
Id	integer	The ID of the requirement item for the check item.	46
ShowName	string	The display name of the requirement item for the check item.	Networking
TotalCheckCount	integer	The total number of check items for the requirement.	36
Sections	array<object>	The information about the sections of check items.
	object	The information about the section of the check item.
Id	integer	The ID of the section for the check item.	177
ShowName	string	The display name of the section for the check item.	Access Control
Id	integer	The standard ID of the check item.	8
Type	string	The standard type of the check item. Valid values: RISK: security risk. IDENTITY_PERMISSION: CIEM. COMPLIANCE: security compliance.	IDENTITY_PERMISSION
ShowName	string	The display name of the standard for the check item.	Alibaba Cloud best security practices
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.	379a9b8f-107b-4630-9e95-2299a1ea****

Examples

Success response

JSON format

{
  "CheckStructureResponse": [
    {
      "StandardType": "RISK",
      "Standards": [
        {
          "Requirements": [
            {
              "Id": 46,
              "ShowName": "Networking",
              "TotalCheckCount": 36,
              "Sections": [
                {
                  "Id": 177,
                  "ShowName": "Access Control"
                }
              ]
            }
          ],
          "Id": 8,
          "Type": "IDENTITY_PERMISSION",
          "ShowName": "Alibaba Cloud best security practices"
        }
      ]
    }
  ],
  "RequestId": "379a9b8f-107b-4630-9e95-2299a1ea****"
}

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.