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.

RiskId Long Yes 1

The ID of the risk item.

Note To query information about servers on which a baseline check is performed, you must specify the ID of the risk item that is related to the baseline check. You can call the DescribeCheckWarningSummary operation to query the IDs.
SourceIp String No 1.2.3.4

The source IP address of the request.

Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English
MachineName String No Test server for a baseline check

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

Uuids String No xxx-aaa-bbb-ccc

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

StrategyId Long No 1

The ID of the baseline check policy.

PageSize Integer No 10

The number of entries to return on each page.

CurrentPage Integer No 1

The page number of the current page.

Response parameters

Parameter Type Example Description
Count Integer 10

The number of entries returned on the current page.

CurrentPage Integer 1

The page number of the current page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 00BDE2-284A-4534-BD09-FB69836DD750

The ID of the request.

TotalCount Integer 100

The total number of returned entries.

WarningMachines Array of WarningMachine

The information about the servers on which alerts are generated.

HighWarningCount Integer 10

The number of high-risk items.

InstanceId String i-m5ee8b9nr3h30mhb****

The instance ID of the server.

InstanceName String aaawebtest

The name of the instance.

InternetIp String 1.2.3.4

The public IP address of the server.

IntranetIp String 1.2.3.5

The internal IP address of the server.

LowWarningCount Integer 3

The number of low-risk items.

MediumWarningCount Integer 2

The number of medium-risk items.

PassCount Integer 10

The number of the check items that have passed the baseline check.

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.
RegionId String cn-qingdao

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

Status Integer 1

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

  • 1: complete
  • 2: verifying
Uuid String xxx-aaa-bbb-ccc

The ID of the server on which a baseline check is performed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeWarningMachines
&RiskId=1
&<Common request parameters>

Sample success responses

XML format

<TotalCount>100</TotalCount>
<PageSize>10</PageSize>
<RequestId>00BDE2-284A-4534-BD09-FB69836DD750</RequestId>
<CurrentPage>1</CurrentPage>
<WarningMachines>
    <Status>1</Status>
    <InstanceName>aaawebtest</InstanceName>
    <MediumWarningCount>2</MediumWarningCount>
    <Uuid>xxx-aaa-bbb-ccc</Uuid>
    <InternetIp>1.2.3.4</InternetIp>
    <InstanceId>i-m5ee8b9nr3h30mhb****</InstanceId>
    <PortOpen>true</PortOpen>
    <HighWarningCount>10</HighWarningCount>
    <RegionId>cn-qingdao</RegionId>
    <PassCount>10</PassCount>
    <IntranetIp>1.2.3.5</IntranetIp>
    <LowWarningCount>3</LowWarningCount>
</WarningMachines>
<Count>10</Count>
</DescribeWarningMachinesResponse>

JSON format

{
    "TotalCount": 100,
    "PageSize": 10,
    "RequestId": "00BDE2-284A-4534-BD09-FB69836DD750",
    "CurrentPage": 1,
    "WarningMachines": {
        "Status": 1,
        "InstanceName": "aaawebtest",
        "MediumWarningCount": 2,
        "Uuid": "xxx-aaa-bbb-ccc",
        "InternetIp": "1.2.3.4",
        "InstanceId": "i-m5ee8b9nr3h30mhb****",
        "PortOpen": true,
        "HighWarningCount": 10,
        "RegionId": "cn-qingdao",
        "PassCount": 10,
        "IntranetIp": "1.2.3.5",
        "LowWarningCount": 3
    },
    "Count": 10
}

Error codes

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