DescribeCheckWarningSummary API Reference - Security Center - Alibaba Cloud - Security Center

Queries the statistics of baseline check results, such as the number of servers checked, the number of check items, and the latest check pass rate.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	219.133.XX.XX
Lang	string	No	The language of the request and response. Valid values: zh: Chinese en: English.	zh
TypeName	string	No	The level-1 type of the baseline. Note Call the DescribeRiskType operation to obtain this parameter.	database
Status	string	No	The status of the check item. Valid values: 1: failed 2: verifying 3: passed 5: expired 6: ignored.	1
RiskStatus	integer	No	The status of the baseline check. Valid values: 1: failed 3: passed.	1
RiskName	string	No	The name of the baseline check risk item.	Redis
StrategyId	integer	No	The ID of the baseline check policy.	1
Uuids	string	No	The UUID of the asset. Note Call the DescribeCloudCenterInstances operation to obtain this parameter.	f03259d8-1e81-4fae-bcbb-275fb5****
PageSize	integer	No	The maximum number of entries per page for a paged query.	10
CurrentPage	integer	No	The page number for a paged query.	1
ClusterId	string	No	The ID of the container cluster to query. Note Call the DescribeGroupedContainerInstances operation to obtain this parameter.	c80dae73bd1be442699766b14ffd0****
ContainerFieldName	string	No	The container field. Valid values: clusterId: cluster ID image: image name imageId: image ID namespace: namespace.	namespace
ContainerFieldValue	string	No	The value of the container field.	c819391d2d520485fa3e81e2dc2ea****
TargetType	string	No	The query type. Valid values: uuid: asset ID.	uuid
GroupId	integer	No	The group ID of the server to query. Note Call the DescribeAllGroups operation to obtain the group ID of the server.	123

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number of the returned results.	1
PageSize	integer	The maximum number of entries per page for a paged query.	10
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.	00BD7CE2-284A-4534-BD09-FB69836DD750
TotalCount	integer	The total number of baseline check items.	100
Count	integer	The number of check items displayed on the current page.	10
WarningSummarys	array<object>	The statistics of check items.
	object	The statistics of check items.
LowWarningCount	integer	The number of low-risk check items.	3
CheckCount	integer	The number of baseline check items.	10
MediumWarningCount	integer	The number of medium-risk check items.	2
LastFoundTime	string	The time when the last baseline check was performed.	2019-01-01 12:23:00
RiskId	integer	The ID of the risk item.	118
SubTypeAlias	string	The level-2 category of the risk item.	Redis
WarningMachineCount	integer	The number of assets on which baseline risks are detected.	11
HighWarningCount	integer	The number of high-risk check items.	1
TypeAlias	string	The category of the baseline check item, such as database, system, weak password detection, and middleware.	databases
RiskName	string	The name of the baseline check risk item.	Redis
Level	string	The risk level of the baseline check risk item. Valid values: high: high medium: medium low: low.	high
CheckExploit	boolean	Indicates whether the risk item is exploitable. Valid values: true: exploitable false: not exploitable.	false
DatabaseRisk	boolean	Indicates whether the risk item is a database risk. Valid values: true: yes false: no.	false
ContainerRisk	boolean	Indicates whether the baseline belongs to the container runtime category. Valid values: true: yes false: no.	false

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "PageSize": 10,
  "RequestId": "00BD7CE2-284A-4534-BD09-FB69836DD750",
  "TotalCount": 100,
  "Count": 10,
  "WarningSummarys": [
    {
      "LowWarningCount": 3,
      "CheckCount": 10,
      "MediumWarningCount": 2,
      "LastFoundTime": "2019-01-01 12:23:00",
      "RiskId": 118,
      "SubTypeAlias": "Redis",
      "WarningMachineCount": 11,
      "HighWarningCount": 1,
      "TypeAlias": "databases",
      "RiskName": "Redis",
      "Level": "high",
      "CheckExploit": false,
      "DatabaseRisk": false,
      "ContainerRisk": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
400	ConsoleError	The error message is %s %s.
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.