You can call this operation to query the summary of check items for cloud platform configurations.
You can call this operation to query the summary of check items for cloud platform configurations. The operation returns the following information: the number of detected risks, the risk rate, the number of affected assets, the last check time, and the statistics of each type of check items.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeRiskCheckSummary |
The operation that you want to perform. Set the value to DescribeRiskCheckSummary. |
Lang | String | No | cn |
The language of the request and response. Chinese and English are supported. |
SourceIp | String | No | 1.1.1.1 |
The source IP address of the request. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 291B49F9-1685-4005-9D34-606B6F78740F |
The ID of the request. |
RiskCheckSummary |
The summary of check items for cloud platform configurations. |
||
AffectedAssetCount | Integer | 0 |
The number of affected assets. |
DisabledRiskCount | Integer | 0 |
The number of failed check items. |
EnabledRiskCount | Integer | 3 |
The number of successful check items. |
Groups |
The types of check items. |
||
CountByStatus |
The results of check items. |
||
Count | Integer | 2 |
The number of detected risks. |
Status | String | pass |
The status of the check item after the check is complete. Valid values:
|
Id | Long | 1 |
The type ID of the check item. |
RemainingTime | Integer | 0 |
The time when the next check will be performed. |
Sort | Integer | 1 |
The sequence number of the check item type in the All Types drop-down list in the Security Center console. |
Status | String | finish |
Indicates whether the check is complete. Valid values:
|
Title | String | Identity authentication and permissions |
The type of the check item. |
ItemCount | Integer | 4 |
The number of check items. |
PreviousCount | Integer | 0 |
The number of risks detected in the previous check. |
PreviousTime | Long | 1545012926000 |
The time when the previous check was performed. |
RiskCount | Integer | 1 |
The number of detected risks. |
RiskLevelCount |
The number of risks for each severity level. Severity levels include:
|
||
Count | Integer | 1 |
The number of risks. |
Key | String | medium |
The severity level. |
RiskRate | Float | 0.25 |
The proportion of detected risks in the total number of check items. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeRiskCheckSummary
&<Common request parameters>
Sample success responses
XML
format
<DescribeRiskCheckSummaryResponse>
<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 audit</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 protection</Title>
<Id>6</Id>
</Groups>
<PreviousCount>0</PreviousCount>
</RiskCheckSummary>
</DescribeRiskCheckSummaryResponse>
JSON
format
{
"RequestId":"291B49F9-1685-4005-9D34-606B6F78740F",
"RiskCheckSummary":{
"Groups":[
{
"Sort":1,
"Status":"finish",
"CountByStatus":[
{
"Status":"exception",
"Count":2
}
],
"Id":1,
"Title":"Identity authentication and permissions",
"RemainingTime":0
},
{
"Sort":2,
"Status":"finish",
"CountByStatus":[
{
"Status":"exception",
"Count":5
}
],
"Id":2,
"Title":"Network access control",
"RemainingTime":0
},
{
"Sort":3,
"Status":"finish",
"CountByStatus":[
{
"Status":"pass",
"Count":1
}
],
"Id":3,
"Title":"Log audit",
"RemainingTime":0
},
{
"Sort":4,
"Status":"finish",
"CountByStatus":[
{
"Status":"exception",
"Count":2
}
],
"Id":4,
"Title":"Data security",
"RemainingTime":0
},
{
"Sort":6,
"Status":"finish",
"CountByStatus":[
{
"Status":"exception",
"Count":2
}
],
"Id":6,
"Title":"Basic protection",
"RemainingTime":0
}
],
"PreviousCount":0,
"RiskCount":1,
"ItemCount":4,
"PreviousTime":1545012926000,
"AffectedAssetCount":0,
"RiskRate":0.25,
"RiskLevelCount":[
{
"Key":"medium",
"Count":1
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.