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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRiskCheckSummary

The operation that you want to perform. Set the value to DescribeRiskCheckSummary.

SourceIp String No 1.2.X.X

The source IP address of the request.

Lang String No zh

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

  • zh: Chinese
  • en: English
ResourceDirectoryAccountId String No 1232428423234****

The ID of the member that is added to the multi-account control list.

Response parameters

Parameter Type Example Description
RequestId String 291B49F9-1685-4005-9D34-606B6F78740F

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

RiskCheckSummary Object

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

ItemCount Integer 4

The number of check items.

AffectedAssetCount Integer 0

The number of affected assets.

DisabledRiskCount Integer 0

The number of the check items that fail the check.

RiskCount Integer 1

The number of detected risk items.

RiskRate Float 0.25

The proportion of risk items to all check items.

PreviousCount Integer 0

The number of detected risk items in the last check.

PreviousTime Long 1545012926000

The timestamp of the last check. Unit: milliseconds.

EnabledRiskCount Integer 3

The number of the check items that pass the check.

RiskLevelCount Array of levelCount

The number of check items at each severity level. Valid values:

  • high
  • medium
  • low
Key String medium

The severity level of a check item.

Count Integer 1

The number of check items at a specific severity level.

Groups Array of group

The statistics of each type of check item.

RemainingTime Integer 0

The remaining time before the check is complete.

Status String finish

The status of the check. Valid values:

  • finish: The check is finished.
  • running: The check is in process.
  • waiting: The check is pending.
  • notStart: The check is not started.
Sort Integer 1

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

Title String Identity authentication and permissions

The type of the check items.

Id Long 1

The type ID of the check item.

CountByStatus Array of statusCount

The statistics of check items.

Status String pass

The status of a check item after the check is finished. Valid values:

  • pass: The check item passes the check, which indicates that the check item is normal.
  • failed: The check item fails the check, which indicates that risks are detected for the check item.
Count Integer 2

The number of detected risk items.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRiskCheckSummary
&SourceIp=1.2.X.X
&ResourceOwnerId=12345
&Lang=zh
&ResourceDirectoryAccountId=1232428423234****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRiskCheckSummaryResponse>
    <RequestId>291B49F9-1685-4005-9D34-606B6F78740F</RequestId>
    <RiskCheckSummary>
        <ItemCount>4</ItemCount>
        <AffectedAssetCount>0</AffectedAssetCount>
        <DisabledRiskCount>0</DisabledRiskCount>
        <RiskCount>1</RiskCount>
        <RiskRate>0.25</RiskRate>
        <PreviousCount>0</PreviousCount>
        <PreviousTime>1545012926000</PreviousTime>
        <EnabledRiskCount>3</EnabledRiskCount>
        <RiskLevelCount>
            <Key>medium</Key>
            <Count>1</Count>
        </RiskLevelCount>
        <Groups>
            <RemainingTime>0</RemainingTime>
            <Status>finish</Status>
            <Sort>1</Sort>
            <Title>Identity authentication and permissions</Title>
            <Id>1</Id>
            <CountByStatus>
                <Status>pass</Status>
                <Count>2</Count>
            </CountByStatus>
        </Groups>
    </RiskCheckSummary>
</DescribeRiskCheckSummaryResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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",
      "Id" : 1,
      "CountByStatus" : [ {
        "Status" : "pass",
        "Count" : 2
      } ]
    } ]
  }
}

Error codes

HTTP status code Error code Error message Description
400 NoPermission no permission The error message returned because you do not have access permissions on the service.
500 ServerError ServerError The error message returned because a server error occurred.

For a list of error codes, visit the API Error Center.