All Products
Search
Document Center

Security Center:DescribeCheckWarningMachines

Last Updated:Nov 13, 2024

Queries the servers on which the same risk item is detected by specifying a baseline and a check item.

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:DescribeCheckWarningMachinesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RiskIdlongNo

The ID of the baseline.

Note You can call the DescribeCheckWarningSummary operation to query the IDs of baselines.
43
CheckIdlongNo

The ID of the check item.

Note You can call the DescribeCheckWarningSummary operation to query the IDs of check items.
58
StatusintegerNo

The risk status of the check item. Valid values:

  • 1: failed
  • 3: passed
1
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
ResourceDirectoryAccountIdlongNo

The Alibaba Cloud account ID of the member in the resource directory.

Note You can call the DescribeMonitorAccounts operation to obtain the IDs.
1232428423234****
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

10
RemarkstringNo

The information about the server that you want to query. The value can be the name or the public IP address of the server.

1.2.XX.XX
InstanceIdstringNo

The instance ID of the asset.

cri-rv4nvbv8iju4****
FilterUuidstringNo

The instance ID of the asset that you don't want to query.

2f64e1a0f9316c48*******

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Machinesarray<object>

The servers on which the same risk item is detected.

Machineobject

The information about the server.

Uuidstring

The UUID of the server.

D0D6E6E4-CB8C-4897-B852-46AEFDA0****
InstanceNamestring

The instance name of the server.

win-oracl****
InternetIpstring

The public IP address of the server.

8.210.XX.XX
IntranetIpstring

The private IP address of the server.

172.25.XX.XX
InstanceIdstring

The instance ID of the server.

i-bp1dp42hgn1xcq8l****
RegionIdstring

The ID of the region in which the server resides.

cn-hangzhou
Bindboolean

Indicates whether Security Center is authorized to protect the asset. Valid values:

  • true
  • false
true
Countinteger

The number of the servers on which the same risk item is detected.

10
RequestIdstring

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

B3D989EB-2E59-584C-8438-5DFAA34A****
PageSizeinteger

The number of entries returned per page.

20
CurrentPageinteger

The number of the page to return. Default value: 1.

1

Examples

Sample success responses

JSONformat

{
  "Machines": [
    {
      "Uuid": "D0D6E6E4-CB8C-4897-B852-46AEFDA0****",
      "InstanceName": "win-oracl****",
      "InternetIp": "8.210.XX.XX",
      "IntranetIp": "172.25.XX.XX",
      "InstanceId": "i-bp1dp42hgn1xcq8l****",
      "RegionId": "cn-hangzhou",
      "Bind": true
    }
  ],
  "Count": 10,
  "RequestId": "B3D989EB-2E59-584C-8438-5DFAA34A****",
  "PageSize": 20,
  "CurrentPage": 1
}

Error codes

HTTP status codeError codeError messageDescription
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-
500RdCheckInnerErrorResource directory account service internal error.-

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

Change history

Change timeSummary of changesOperation
2024-07-04The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-11-14The Error code has changed. The request parameters of the API has changedView Change Details