GetCheckSummary - Security Center - Alibaba Cloud Documentation Center

Queries the summary information about the configuration checks on cloud services.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:GetCheckSummary	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Valid values: zh: Chinese en: English	zh
ResourceDirectoryAccountId	string	No	The Alibaba Cloud account ID of the member in the resource directory. Note You can call the DescribeMonitorAccounts operation to query the IDs of Alibaba Cloud accounts.	000
Vendors	array	No	The cloud service providers.
	string	No	The cloud service provider. Valid values: ALIYUN: an asset provided by Alibaba Cloud TENCENT: an asset provided by Tencent Cloud AWS: an asset provided by Amazon Web Services (AWS) HUAWEICLOUD: an asset provided by Huawei Cloud MICROSOFT: an asset provided by Microsoft Azure	ALIYUN
IsItemStatistic	boolean	No	Specifies whether to return the statistics of the check items, including the number of check items supported by the system and the number of check items available to you. Default value: false. Valid values: true false	false

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Summarys	array<object>	The summary information about the configuration checks on cloud services.
Summarys	object	The information about the configuration check on cloud services.
Type	string	The type of the check item. Valid values: COMPLIANCE RISK IDENTITY_PERMISSION	IDENTITY_PERMISSION
PassCount	long	The number of check items that pass the check.	10
FailCount	integer	The number of detected risk items.	5
Standards	array<object>	The information about the check items.
Standards	object	The standard ID of the check item.
Id	long	The ID of the check item.	1
ShowName	string	The name of the check item.	Identity and permission management
PassCount	integer	The number of check items that pass the check.	1
FailCount	integer	The number of check items that failed to pass the check.	1
RiskLevelHighCount	integer	The number of high-risk items.	1
RiskLevelMediumCount	integer	The number of medium-risk items.	1
RiskLevelLowCount	integer	The number of low-risk items.	1
StandardStatistic	object	The standard statistics of the check items.
PassCount	integer	The number of check items that pass the check.	3
PassLowCount	integer	The number of low-risk check items that pass the check.	1
PassMediumCount	integer	The number of medium-risk check items that pass the check.	1
PassHighCount	integer	The number of high-risk check items that pass the check.	1
NotPassCount	integer	The number of check items that failed to pass the check.	3
NotPassLowCount	integer	The number of low-risk check items that failed to pass the check.	1
NotPassMediumCount	integer	The number of medium-risk check items that failed to pass the check.	1
NotPassHighCount	integer	The number of high-risk check items that failed to pass the check.	1
NotCheckCount	integer	The number of unchecked check items.	3
NotCheckLowCount	integer	The number of unchecked low-risk check items.	1
NotCheckMediumCount	integer	The number of unchecked medium-risk check items.	1
NotCheckHighCount	integer	The number of unchecked high-risk check items.	1
TypeStatistic	object	The risk statistics by type.
PassCount	integer	The number of check items that pass the check.	3
PassLowCount	integer	The number of low-risk check items that pass the check.	1
PassMediumCount	integer	The number of medium-risk check items that pass the check.	1
PassHighCount	integer	The number of high-risk check items that pass the check.	1
NotPassCount	integer	The number of check items that failed to pass the check.	3
NotPassLowCount	integer	The number of low-risk check items that failed to pass the check.	1
NotPassMediumCount	integer	The number of medium-risk check items that failed to pass the check.	1
NotPassHighCount	integer	The number of high-risk check items that failed to pass the check.	1
NotCheckCount	integer	The number of unchecked check items.	3
NotCheckLowCount	integer	The number of unchecked low-risk check items.	1
NotCheckMediumCount	integer	The number of unchecked medium-risk check items.	1
NotCheckHighCount	integer	The number of unchecked high-risk check items.	1
OverallStatistic	object	The overall risk statistics.
PassCount	integer	The number of check items that pass the check.	3
PassLowCount	integer	The number of low-risk check items that pass the check.	1
PassMediumCount	integer	The number of medium-risk check items that pass the check.	1
PassHighCount	integer	The number of high-risk check items that pass the check.	1
NotPassCount	integer	The number of check items that failed to pass the check.	3
NotPassLowCount	integer	The number of low-risk check items that failed to pass the check.	1
NotPassMediumCount	integer	The number of medium-risk check items that failed to pass the check.	1
NotPassHighCount	integer	The number of high-risk check items that failed to pass the check.	1
NotCheckCount	integer	The number of unchecked check items.	3
NotCheckLowCount	integer	The number of unchecked low-risk check items.	1
NotCheckMediumCount	integer	The number of unchecked medium-risk check items.	1
NotCheckHighCount	integer	The number of unchecked high-risk check items.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	843E4805-****-7EE12FA8DBFD
OverallItemStatistic	object	The statistics about the number of check items.
ResultCount	integer	The number of check items available to you.	25
ReleaseCount	integer	The number of check items supported by the system.	620

Examples

Sample success responses

JSONformat

{
  "Summarys": [
    {
      "Type": "IDENTITY_PERMISSION",
      "PassCount": 10,
      "FailCount": 5,
      "Standards": [
        {
          "Id": 1,
          "ShowName": "Identity and permission management\n",
          "PassCount": 1,
          "FailCount": 1,
          "RiskLevelHighCount": 1,
          "RiskLevelMediumCount": 1,
          "RiskLevelLowCount": 1,
          "StandardStatistic": {
            "PassCount": 3,
            "PassLowCount": 1,
            "PassMediumCount": 1,
            "PassHighCount": 1,
            "NotPassCount": 3,
            "NotPassLowCount": 1,
            "NotPassMediumCount": 1,
            "NotPassHighCount": 1,
            "NotCheckCount": 3,
            "NotCheckLowCount": 1,
            "NotCheckMediumCount": 1,
            "NotCheckHighCount": 1
          }
        }
      ],
      "TypeStatistic": {
        "PassCount": 3,
        "PassLowCount": 1,
        "PassMediumCount": 1,
        "PassHighCount": 1,
        "NotPassCount": 3,
        "NotPassLowCount": 1,
        "NotPassMediumCount": 1,
        "NotPassHighCount": 1,
        "NotCheckCount": 3,
        "NotCheckLowCount": 1,
        "NotCheckMediumCount": 1,
        "NotCheckHighCount": 1
      }
    }
  ],
  "OverallStatistic": {
    "PassCount": 3,
    "PassLowCount": 1,
    "PassMediumCount": 1,
    "PassHighCount": 1,
    "NotPassCount": 3,
    "NotPassLowCount": 1,
    "NotPassMediumCount": 1,
    "NotPassHighCount": 1,
    "NotCheckCount": 3,
    "NotCheckLowCount": 1,
    "NotCheckMediumCount": 1,
    "NotCheckHighCount": 1
  },
  "RequestId": "843E4805-****-7EE12FA8DBFD",
  "OverallItemStatistic": {
    "ResultCount": 25,
    "ReleaseCount": 620
  }
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-22	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-12-21	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-01-11	The API operation is not deprecated.	View Change Details