DescribeClusterHostSecuritySummary API Overview - Security Center - Alibaba Cloud - Security Center

Queries the security statistics of a host.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	222.71.XXX.XXX
ClusterId	string	No	The ID of the container cluster.	c3aaf6c8085f84791882eef200cd2****
ContainerFieldName	string	No	The container search field. Valid values: instanceId: instance ID. appName: application name. clusterId: cluster ID. regionId: region. nodeName: node name. namespace: namespace. clusterName: cluster name. image: image name. imageRepoName: image repository name. imageRepoNamespace: image repository namespace. imageRepoTag: image tag. imageDigest: image digest.	clusterId
ContainerFieldValue	string	No	The value of the container search field.	c1fdb5fd8d42e425d88fd73eec7be****
TargetType	string	No	The query type. Valid values: containerId: container ID. uuid: asset ID.	uuid

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0B48AB3C-84FC-424D-A01D-B9270EF4****
ClusterHostEvent	object	The host alert details.
AlarmEvent	array<object>	The host alert details.
	object
RiskLevel	string	The alert level. Valid values: serious suspicious remind	remind
Count	integer	The number of alerts.	1
VulEvent	array<object>	The host vulnerability details.
	object
RiskLevel	string	The risk level of the vulnerability. Valid values: asap: high. You must fix the vulnerability at the earliest opportunity. nntf: medium. You can fix the vulnerability based on your business requirements. later: low. You can ignore the vulnerability.	later
Count	integer	The number of vulnerabilities.	3
BaselineEvent	array<object>	The host baseline details.
	object
RiskLevel	string	The risk level of the baseline. Valid values: high medium low	medium
Count	integer	The number of baselines.	1

Examples

Success response

JSON format

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF4****",
  "ClusterHostEvent": {
    "AlarmEvent": [
      {
        "RiskLevel": "remind",
        "Count": 1
      }
    ],
    "VulEvent": [
      {
        "RiskLevel": "later",
        "Count": 3
      }
    ],
    "BaselineEvent": [
      {
        "RiskLevel": "medium",
        "Count": 1
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.