All Products
Search
Document Center

Security Center:DescribeRiskCheckSummary

Last Updated:Feb 20, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeRiskCheckSummaryRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

1.2.XX.XX
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
ResourceDirectoryAccountIdstringNo

The ID of the Alibaba Cloud account that is added as a member by using the multi-account control feature.

1232428423234****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

291B49F9-1685-4005-9D34-606B6F78740F
RiskCheckSummaryobject

The summary information about the check results of cloud service configurations.

ItemCountinteger

The number of check items.

4
AffectedAssetCountinteger

The number of affected assets.

0
DisabledRiskCountinteger

The number of the check items that failed the check.

0
RiskCountinteger

The number of detected risk items.

1
RiskRatefloat

The proportion of risk items to all check items.

0.25
PreviousCountinteger

The number of risk items detected in the last check.

0
PreviousTimelong

The timestamp of the last check. Unit: milliseconds.

1545012926000
EnabledRiskCountinteger

The number of the check items that passed the check.

3
RiskLevelCountobject []

An array that consists of the number of check items at each risk level.

Keystring

The risk level of the check items. Valid values:

  • high
  • medium
  • low
medium
Countinteger

The number of check items at the specified risk level.

1
Groupsobject []

An array that consists of the statistics for each type of check item.

RemainingTimeinteger

The remaining time before the check is complete.

0
Statusstring

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
Sortinteger

The sequence number of the check item type in the All Types drop-down list in the Security Center console.

1
Titlestring

The name of the check item type.

Identity authentication and permissions
Idlong

The ID of the check item type.

1
CountByStatusobject []

An array that consists of the statistics about check results.

Statusstring

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
Countinteger

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 codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history