All Products
Search
Document Center

Security Center:DescribeContainerStatistics

Last Updated:Nov 25, 2024

Queries the alert statistics of container assets.

Operation description

Only users who created a Container Registry Enterprise Edition instance can call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeContainerStatisticsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the specified container cluster.

Note You can call the DescribeGroupedContainerInstances operation to obtain the cluster ID.
Cccfd68c474454665ace07efce924****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8
Dataobject

The alert statistics of container assets.

TotalNodeinteger

The total number of nodes in the current container cluster.

12
RemindAlarmCountinteger

The number of alerts whose risk level is Reminder.

1
TotalAlarmCountinteger

The total number of alerts that are generated in the current container cluster.

6
SuspiciousAlarmCountinteger

The number of alerts whose risk level is Suspicious.

3
SeriousAlarmCountinteger

The number of alerts whose risk level is Urgent.

2
hasRiskNodeinteger

The number of nodes on which alerts are generated in the current container cluster.

4

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.