Container Asset Alert Statistics API Overview - Security Center - Alibaba Cloud - Security Center

Operation description

Only users who have purchased Container Registry Enterprise instances can invoke this operation.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the container cluster to query. Note You can call the DescribeGroupedContainerInstances operation to obtain this parameter.	Cccfd68c474454665ace07efce924****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request, which can be used for troubleshooting and diagnostics.	21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8
Data	object	The detailed alert statistics of container assets.
TotalNode	integer	The total number of nodes in the container cluster.	12
RemindAlarmCount	integer	The number of alerts with the Reminder risk level.	1
TotalAlarmCount	integer	The total number of security alerts in the container cluster.	6
SuspiciousAlarmCount	integer	The number of alerts with the Suspicious risk level.	3
SeriousAlarmCount	integer	The number of alerts with the Urgent risk level.	2
hasRiskNode	integer	The number of nodes that have alerts in the container cluster.	4

Examples

Success response

JSON format

{
  "RequestId": "21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8",
  "Data": {
    "TotalNode": 12,
    "RemindAlarmCount": 1,
    "TotalAlarmCount": 6,
    "SuspiciousAlarmCount": 3,
    "SeriousAlarmCount": 2,
    "hasRiskNode": 4
  }
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
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.