Use GetCheckSummary to query the summary of configuration checks - Security Center

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

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

get

*All Resource

*

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
TaskSources	array	No	List of task sources.
	string	No	Task source. Values: YAO_CHI: YaoChi Console.	YAO_CHI

Response elements

Element	Type	Description	Example
	object	The response parameters.
Summarys	array<object>	The summary information about the configuration checks on cloud services.
	array<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	integer	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.
	array<object>	The standard ID of the check item.
Id	integer	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

Success response

JSON format

{
  "Summarys": [
    {
      "Type": "IDENTITY_PERMISSION",
      "PassCount": 10,
      "FailCount": 5,
      "Standards": [
        {
          "Id": 1,
          "ShowName": "Identity and permission management",
          "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
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.