Queries the summary information of check items for 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 items.

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.3.4

The source IP address of the request.

Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English

Response parameters

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

The ID of the request.

RiskCheckSummary Struct

The summary information of check items for cloud service configurations.

RiskCount Integer 1

The total number of risk items.

PreviousCount Integer 0

The number of risk items in the last check.

ItemCount Integer 4

The number of check items.

RiskRate Float 0.25

The proportion of risk items to the total number of check items.

AffectedAssetCount Integer 0

The number of affected assets.

PreviousTime Long 1545012926000

The timestamp of the last check.

EnabledRiskCount Integer 3

The number of the items that passed the check.

DisabledRiskCount Integer 0

The number of the risk items detected in the check.

RiskLevelCount Array

The number of risk items at each level.

  • high
  • medium
  • low
Key String medium

The risk level of the risk item.

Count Integer 1

The number of risk items.

Groups Array

The statistics on the types of check items.

Id Long 1

The type ID of the check item.

Title String Identity authentication and permissions

The type of the check item.

Status String finish

Indicates whether the check is finished. Valid values:

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

The time when the next check will be performed.

Sort Integer 1

The sequence number of the type of the check item. The sequence number is consistent with that in the All Types drop-down list on the Cloud Platform Configuration Assessment page.

CountByStatus Array

The statistics on check results.

Status String pass

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

  • pass: The check item is normal.
  • failed: The check item is at risk.
Count Integer 2

The number of risk items for each type.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRiskCheckSummary
&<Common request parameters>

Sample success responses

XML format 

<DescribeRiskCheckSummary>
	  <RequestId>291B49F9-1685-4005-9D34-606B6F78740F</RequestId>
	  <RiskCheckSummary>
		    <RiskCount>1</RiskCount>
		    <RiskRate>0.25</RiskRate>
		    <PreviousTime>1545012926000</PreviousTime>
		    <ItemCount>4</ItemCount>
		    <AffectedAssetCount>0</AffectedAssetCount>
		    <RiskLevelCount>
			      <Count>1</Count>
			      <Key>medium</Key>
		    </RiskLevelCount>
		    <Groups>
			      <Status>finish</Status>
			      <CountByStatus>
				        <Status>exception</Status>
				        <Count>2</Count>
			      </CountByStatus>
			      <RemainingTime>0</RemainingTime>
			      <Sort>1</Sort>
			      <Title>Identity authentication and permissions</Title>
			      <Id>1</Id>
		    </Groups>
		    <Groups>
			      <Status>finish</Status>
			      <CountByStatus>
				        <Status>exception</Status>
				        <Count>5</Count>
			      </CountByStatus>
			      <RemainingTime>0</RemainingTime>
			      <Sort>2</Sort>
			      <Title>Network access control</Title>
			      <Id>2</Id>
		    </Groups>
		    <Groups>
			      <Status>finish</Status>
			      <CountByStatus>
				        <Status>pass</Status>
				        <Count>1</Count>
			      </CountByStatus>
			      <RemainingTime>0</RemainingTime>
			      <Sort>3</Sort>
			      <Title>Log auditing</Title>
			      <Id>3</Id>
		    </Groups>
		    <Groups>
			      <Status>finish</Status>
			      <CountByStatus>
				        <Status>exception</Status>
				        <Count>2</Count>
			      </CountByStatus>
			      <RemainingTime>0</RemainingTime>
			      <Sort>4</Sort>
			      <Title>Data security</Title>
			      <Id>4</Id>
		    </Groups>
		    <Groups>
			      <Status>finish</Status>
			      <CountByStatus>
				        <Status>exception</Status>
				        <Count>2</Count>
			      </CountByStatus>
			      <RemainingTime>0</RemainingTime>
			      <Sort>6</Sort>
			      <Title>Basic security protection</Title>
			      <Id>6</Id>
		    </Groups>
		    <PreviousCount>0</PreviousCount>
	  </RiskCheckSummary>
    </DescribeRiskCheckSummary>

JSON format 

{
  "RequestId": "291B49F9-1685-4005-9D34-606B6F78740F",
  "RiskCheckSummary": {
    "RiskCount": 1,
    "RiskRate": 0.25,
    "PreviousTime": 1545012926000,
    "ItemCount": 4,
    "AffectedAssetCount": 0,
    "RiskLevelCount": [
      {
        "Count": 1,
        "Key": "medium"
      }
    ],
    "Groups": [
      {
        "Status": "finish",
        "CountByStatus": [
          {
            "Status": "exception",
            "Count": 2
          }
        ],
        "RemainingTime": 0,
        "Sort": 1,
        "Title": "Identity authentication and permissions",
        "Id": 1
      },
      {
        "Status": "finish",
        "CountByStatus": [
          {
            "Status": "exception",
            "Count": 5
          }
        ],
        "RemainingTime": 0,
        "Sort": 2,
        "Title": "Network access control",
        "Id": 2
      },
      {
        "Status": "finish",
        "CountByStatus": [
          {
            "Status": "pass",
            "Count": 1
          }
        ],
        "RemainingTime": 0,
        "Sort": 3,
        "Title": "Log auditing",
        "Id": 3
      },
      {
        "Status": "finish",
        "CountByStatus": [
          {
            "Status": "exception",
            "Count": 2
          }
        ],
        "RemainingTime": 0,
        "Sort": 4,
        "Title": "Data security",
        "Id": 4
      },
      {
        "Status": "finish",
        "CountByStatus": [
          {
            "Status": "exception",
            "Count": 2
          }
        ],
        "RemainingTime": 0,
        "Sort": 6,
        "Title": "Basic security protection",
        "Id": 6
      }
    ],
    "PreviousCount": 0
  }
}

Error codes

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