Queries specific risk items and check items of a specific server.

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 DescribeCheckWarnings

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

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
Uuid String Yes d42f938c-d962-48a0-90f9-05**********

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

Note To query specific risk items and check items of a specific server, you must provide the ID of the server on which the baseline check is performed. You can call the DescribeWarningMachines operation to query the ID.
RiskId Long Yes 10354

The ID of the risk item.

Note To query specific risk items and check items of a specific server, you must provide the IDs of the risk items. You can call the DescribeCheckWarningSummary operation to query the IDs.
PageSize Integer No 20

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

CurrentPage Integer No 1

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

CheckId Long No 2546

The ID of the check item.

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 20

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

RequestId String 0DFCADBA-7065-42DA-AF17-6868B9C2A8CF

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

TotalCount Integer 100

The total number of entries returned.

Count Integer 10

The number of entries returned on the current page.

CheckWarnings Array of CheckWarning

The details about the check item.

Status Integer 1

The status of the check item. Valid values:

  • 1: failed
  • 2: verifying
  • 3: passed
  • 5: expired
  • 6: ignored
CheckWarningId Long 212251441

The ID of the alert that is generated for the baseline check result.

Type String Identity authentication

The type of the check item.

Uuid String d42f938c-d962-48a0-90f9-***********

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

Item String Password expiration alert

The name of the check item.

CheckId Long 2546

The ID of the check item.

Level String high

The severity level of a risk item. Valid values:

  • high
  • medium
  • low

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCheckWarnings
&SourceIp=1.2.XX.XX
&Lang=zh
&Uuid=d42f938c-d962-48a0-90f9-05**********
&RiskId=10354
&PageSize=20
&CurrentPage=1
&CheckId=2546
&Common request parameters

Sample success responses

XML format 

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

<DescribeCheckWarningsResponse>
    <CurrentPage>1</CurrentPage>
    <PageSize>20</PageSize>
    <RequestId>0DFCADBA-7065-42DA-AF17-6868B9C2A8CF</RequestId>
    <TotalCount>100</TotalCount>
    <Count>10</Count>
    <CheckWarnings>
        <Status>1</Status>
        <CheckWarningId>212251441</CheckWarningId>
        <Type>Identity authentication</Type>
        <Uuid>d42f938c-d962-48a0-90f9-***********</Uuid>
        <Item>Password expiration alert</Item>
        <CheckId>2546</CheckId>
        <Level>high</Level>
    </CheckWarnings>
</DescribeCheckWarningsResponse>

JSON format 

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

{
  "CurrentPage" : 1,
  "PageSize" : 20,
  "RequestId" : "0DFCADBA-7065-42DA-AF17-6868B9C2A8CF",
  "TotalCount" : 100,
  "Count" : 10,
  "CheckWarnings" : [ {
    "Status" : 1,
    "CheckWarningId" : 212251441,
    "Type" : "Identity authentication",
    "Uuid" : "d42f938c-d962-48a0-90f9-***********",
    "Item" : "Password expiration alert",
    "CheckId" : 2546,
    "Level" : "high"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 UnknownError UnknownError The error message returned because an unknown error occurred.
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.