DescribeRiskCheckSummary Deprecated API Overview - Security Center - Alibaba Cloud - Security Center

Queries the summary of cloud service configuration check results, including the number of risk items, risk rate, number of affected assets, check time, and statistics by type.

Operation description

This operation is deprecated. Use the GetCheckSummary operation instead.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source that you want to query.	1.2.XX.XX
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh
ResourceDirectoryAccountId	string	No	The Alibaba Cloud account ID of the member account in the resource directory for multi-account security management.	1232428423234****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.	291B49F9-1685-4005-9D34-606B6F78740F
RiskCheckSummary	object	The statistics of cloud service configuration check results.
ItemCount	integer	The number of check items.	4
AffectedAssetCount	integer	The number of assets affected by risk items in the check results.	0
DisabledRiskCount	integer	The number of check items that failed the check.	0
RiskCount	integer	The number of detected risk items.	1
RiskRate	number	The percentage of detected risk items in the total number of check items.	0.25
PreviousCount	integer	The number of risk items detected in the previous check.	0
PreviousTime	integer	The timestamp of the previous check. Unit: milliseconds.	1545012926000
EnabledRiskCount	integer	The number of check items that passed the check.	3
RiskLevelCount	array<object>	The list of check item counts by risk level.
	object	The count of check items for 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>	The statistics information list by check item type.
	array<object>	The statistics information of a check item type.
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.	身份认证及权限
Id	integer	The ID of the check item type.	1
CountByStatus	array<object>	An array that consists of the statistics about check results.
	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

Success response

JSON format

{
  "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": "身份认证及权限",
        "Id": 1,
        "CountByStatus": [
          {
            "Status": "pass",
            "Count": 2
          }
        ]
      }
    ]
  }
}

Error codes

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