Baseline Check Server Identification with DescribeWarningMachines - Security Center - Alibaba Cloud - Security Center

Queries servers that have undergone a baseline check, including server IDs, risk item statistics, and risk item status.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	1.2.XX.XX
Lang	string	No	The language of the request and response content. Default value: zh. Valid values: zh: Chinese en: English	zh
MachineName	string	No	The name of the server on which the baseline check is performed.	oracle-win-001****
Uuids	string	No	The UUID of the server on which the baseline check is performed. Separate multiple UUIDs with commas (,).	9888955c-0076-49da-bd9c-34f5492b****
RiskId	integer	Yes	The ID of the risk item. Note You can call the DescribeCheckWarningSummary operation to query the IDs of risk items.	196
StrategyId	integer	No	The ID of the baseline check policy.	16
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
ClusterId	string	No	The ID of the container cluster. Note You can call the DescribeGroupedContainerInstances operation to query the IDs of container clusters.	c7e3c5b420a7947c2933303144688****
ContainerFieldName	string	No	The field used to search for the container. Valid values: CONTAINER_ID: the ID of the container IMAGE: the name of the image NAMESPACE: the namespace NODE_NAME: the name of the node POD_IP: the IP address of the pod HOST_IP: the IP address of the host INSTANCE_ID: the ID of the instance	containerId
ContainerFieldValue	string	No	The value of the field used to search for the container.	c8bb3ef0f5ccf45508f0fd1ffc200****
TargetType	string	No	The type of the query condition. Valid values: containerId: the ID of the container uuid: the UUID of the asset	uuid
HaveRisk	integer	No	Whether risks were detected. Valid values: 1: yes 0: no	1
GroupId	integer	No	The ID of the asset group. Note You can call the DescribeAllGroups operation to query the IDs of asset groups.	123

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries returned per page. Default value: 10.	10
RequestId	string	The request ID.	6E4CBE87-E887-5AF1-86D2-78EB4AA3E771
TotalCount	integer	The total number of entries returned.	1
Count	integer	The number of entries returned on the current page.	10
WarningMachines	array<object>	The information about the servers.
	object	The information about the servers on which alerts are generated.
Status	integer	The verification status of the risk item after it is fixed. Valid values: 1: complete 2: verifying	1
InternetIp	string	The public IP address of the server.	1.2.XX.XX
InstanceId	string	The server ID.	i-m5ee8b9nr3h30mhb****
HighWarningCount	integer	The number of high-risk items on the server.	10
IntranetIp	string	The private IP address of the server.	1.2.XX.XX
RegionId	string	The region ID of the server.	cn-qingdao
LowWarningCount	integer	The number of low-risk items on the server.	3
PortOpen	boolean	Whether a port on the server is accessible over the Internet. Valid values: true false	true
Uuid	string	The UUID of the server on which the baseline check is performed.	9888955c-0076-49da-bd9c-34f5492b****
MediumWarningCount	integer	The number of medium-risk items on the server.	2
PassCount	integer	The number of check items that passed the baseline check on the server.	10
InstanceName	string	The name of the server.	oracle-win-00****
Bind	boolean	Whether Security Center is authorized to protect the asset. Valid values: true false	true
AuthVersion	integer	The edition of Security Center that is authorized to protect the asset. Valid values: 1: Basic edition 6: Anti-virus edition 5: Advanced edition 3: Enterprise edition 7: Ultimate edition 10: Value-added Plan edition	7
ContainerId	string	The container ID.	48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******
ContainerName	string	The name of the container.	redis
Online	boolean	Whether the agent is online. Valid values: true false	true
AssetType	string	The type of cloud product assets. Note You can call ListCloudAssetInstances to query the types of cloud product assets.	0

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "PageSize": 10,
  "RequestId": "6E4CBE87-E887-5AF1-86D2-78EB4AA3E771",
  "TotalCount": 1,
  "Count": 10,
  "WarningMachines": [
    {
      "Status": 1,
      "InternetIp": "1.2.XX.XX",
      "InstanceId": "i-m5ee8b9nr3h30mhb****",
      "HighWarningCount": 10,
      "IntranetIp": "1.2.XX.XX",
      "RegionId": "cn-qingdao",
      "LowWarningCount": 3,
      "PortOpen": true,
      "Uuid": "9888955c-0076-49da-bd9c-34f5492b****",
      "MediumWarningCount": 2,
      "PassCount": 10,
      "InstanceName": "oracle-win-00****",
      "Bind": true,
      "AuthVersion": 7,
      "ContainerId": "48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******",
      "ContainerName": "redis",
      "Online": true,
      "AssetType": "0"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ConsoleError	The error message is %s %s.
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.