Queries information about servers on which a baseline check is performed. The information includes the statistics and status of risk items and IDs of the servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeWarningMachines

The operation that you want to perform. Set the value to DescribeWarningMachines.

SourceIp String No 1.2.XX.XX

The source IP address of the request.

Lang String No zh

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

  • zh: Chinese
  • en: English
MachineName String No oracle-win-001****

The name of the server on which the baseline check is performed.

Uuids String No 9888955c-0076-49da-bd9c-34f5492b****

The ID of the server on which the baseline check is performed. Separate multiple IDs with commas (,).

RiskId Long Yes 196

The ID of the risk item.

Note You can call the DescribeCheckWarningSummary operation to query the IDs of risk items.
StrategyId Long No 16

The ID of the baseline check policy.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

CurrentPage Integer No 1

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

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page. Default value: 10.

RequestId String 6E4CBE87-E887-5AF1-86D2-78EB4AA3E771

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

TotalCount Integer 1

The total number of entries returned.

Count Integer 10

The number of entries returned on the current page.

WarningMachines Array of WarningMachine

The information about the servers.

Status Integer 1

The verification status of the risk items that are fixed. Valid values:

  • 1: complete
  • 2: verifying
InternetIp String 1.2.XX.XX

The public IP address of the server.

InstanceId String i-m5ee8b9nr3h30mhb****

The instance ID of the server.

HighWarningCount Integer 10

The number of high-risk items on the server.

IntranetIp String 1.2.XX.XX

The private IP address of the server.

RegionId String cn-qingdao

The ID of the region in which the server is deployed.

LowWarningCount Integer 3

The number of low-risk items on the server.

PortOpen Boolean true

Indicates whether a port on the server is accessible from the Internet. Valid values:

  • true: A port on the server is accessible from the Internet.
  • false: No ports on the server are accessible from the Internet.
Uuid String 9888955c-0076-49da-bd9c-34f5492b****

The UUID of the server on which the baseline check is performed.

MediumWarningCount Integer 2

The number of medium-risk items on the server.

PassCount Integer 10

The number of the check items that passed the baseline check on the server.

InstanceName String oracle-win-00****

The name of the server.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeWarningMachines
&SourceIp=1.2.XX.XX
&Lang=zh
&MachineName=oracle-win-001****
&Uuids=9888955c-0076-49da-bd9c-34f5492b****
&RiskId=196
&StrategyId=16
&PageSize=10
&CurrentPage=1
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeWarningMachinesResponse>
    <CurrentPage>1</CurrentPage>
    <PageSize>10</PageSize>
    <RequestId>6E4CBE87-E887-5AF1-86D2-78EB4AA3E771</RequestId>
    <TotalCount>1</TotalCount>
    <Count>10</Count>
    <WarningMachines>
        <Status>1</Status>
        <InternetIp>1.2.XX.XX</InternetIp>
        <InstanceId>i-m5ee8b9nr3h30mhb****</InstanceId>
        <HighWarningCount>10</HighWarningCount>
        <IntranetIp>1.2.XX.XX</IntranetIp>
        <RegionId>cn-qingdao</RegionId>
        <LowWarningCount>3</LowWarningCount>
        <PortOpen>true</PortOpen>
        <Uuid>9888955c-0076-49da-bd9c-34f5492b****</Uuid>
        <MediumWarningCount>2</MediumWarningCount>
        <PassCount>10</PassCount>
        <InstanceName>oracle-win-00****</InstanceName>
    </WarningMachines>
</DescribeWarningMachinesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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****"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 ConsoleError The error message is %s %s. The error message is %s %s.
500 ServerError ServerError The error message returned because a server error occurred.

For a list of error codes, visit the API Error Center.