DescribeRiskCheckSummary - Security Center - Alibaba Cloud Documentation Center

Queries the summary information about the check results of cloud service configurations. The information includes the number of risk items, the risk rate, the number of affected assets, the check time, and the statistics about each type of check items.

Operation description

This operation is phased out. You can use the GetCheckSummary operation.

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:DescribeRiskCheckSummary	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	1.2.XX.XX
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
ResourceDirectoryAccountId	string	No	The ID of the Alibaba Cloud account that is added as a member by using the multi-account control feature.	1232428423234****

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	291B49F9-1685-4005-9D34-606B6F78740F
RiskCheckSummary	object	The summary information about the check results of cloud service configurations.
ItemCount	integer	The number of check items.	4
AffectedAssetCount	integer	The number of affected assets.	0
DisabledRiskCount	integer	The number of the check items that failed the check.	0
RiskCount	integer	The number of detected risk items.	1
RiskRate	float	The proportion of risk items to all check items.	0.25
PreviousCount	integer	The number of risk items detected in the last check.	0
PreviousTime	long	The timestamp of the last check. Unit: milliseconds.	1545012926000
EnabledRiskCount	integer	The number of the check items that passed the check.	3
RiskLevelCount	array<object>	An array that consists of the number of check items at each risk level.
levelCount	object	The number of check items at each risk level.
Key	string	The risk level of the check items. Valid values: high medium low	medium
Count	integer	The number of check items at the specified risk level.	1
Groups	array<object>	An array that consists of the statistics for each type of check item.
group	object	The statistics for each type of check item.
RemainingTime	integer	The remaining time before the check is complete.	0
Status	string	The status of the check. Valid values: finish: The check is finished. running: The check is in progress. waiting: The check is pending. notStart: The check is not started.	finish
Sort	integer	The sequence number of the check item type in the All Types drop-down list in the Security Center console.	1
Title	string	The name of the check item type.	Identity authentication and permissions
Id	long	The ID of the check item type.	1
CountByStatus	array<object>	An array that consists of the statistics about check results.
statusCount	object	The statistics about check results.
Status	string	The status of the check item after the check is finished. Valid values: pass: The check item passed the check, which indicates that the check item is normal. failed: The check item failed the check, which indicates that risks are detected based on the check item.	pass
Count	integer	The number of detected risk items.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "291B49F9-1685-4005-9D34-606B6F78740F",
  "RiskCheckSummary": {
    "ItemCount": 4,
    "AffectedAssetCount": 0,
    "DisabledRiskCount": 0,
    "RiskCount": 1,
    "RiskRate": 0.25,
    "PreviousCount": 0,
    "PreviousTime": 1545012926000,
    "EnabledRiskCount": 3,
    "RiskLevelCount": [
      {
        "Key": "medium",
        "Count": 1
      }
    ],
    "Groups": [
      {
        "RemainingTime": 0,
        "Status": "finish",
        "Sort": 1,
        "Title": "Identity authentication and permissions\n",
        "Id": 1,
        "CountByStatus": [
          {
            "Status": "pass",
            "Count": 2
          }
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	no permission	-
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

No change history