All Products
Search
Document Center

Security Center:DescribeCheckWarnings

Last Updated:Feb 07, 2023

Queries information about specified risk items and the check items of a specified server.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

1.2.XX.XX
LangstringNo

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

  • zh: Chinese
  • en: English
zh
UuidstringYes

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

NoteTo query specified risk items and the check items of a specified 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 IDs of servers.
d42f938c-d962-48a0-90f9-05****
RiskIdlongYes

The ID of the baseline risk item.

NoteTo query specified baseline risk items and the check items of a specified server, you must provide the IDs of the baseline risk items. You can call the DescribeCheckWarningSummary operation to query the IDs.
10354
PageSizeintegerNo

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

20
CurrentPageintegerNo

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

1
CheckIdlongNo

The ID of the check item.

2546
CheckTypestringNo

The type of the check item. Valid values:

  • hc.check.type.identity_auth: identity authentication
  • hc.check.type.access_control: access control
  • hc.check.type.network_service: network and service
  • hc.check.type.service_conf: service configuration
  • hc.check.type.file_rights: file permission
  • hc.check.type.security_audit: security audit
  • hc.check.type.attack_defense: intrusion prevention
  • hc.check.type.others: others
hc.check.type.attack_defense
RiskStatusintegerNo

The status of the check item. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

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

20
RequestIdstring

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

0DFCADBA-7065-42DA-AF17-6868B9C2A8CF
TotalCountinteger

The total number of entries returned.

100
Countinteger

The number of entries returned on the current page.

10
CheckWarningsarray

An array that consists of the details about the check item.

object

The details about the check item.

Statusinteger

The status of the check item. Valid values:

  • 1: failed
  • 2: verifying
  • 3: passed
  • 5: expired
  • 6: ignored
1
CheckWarningIdlong

The ID of the alert that is triggered by the check item.

212251441
Typestring

The type of the check item.

hc.check.type.identity_auth
Uuidstring

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

d42f938c-d962-48a0-90f9-****
Itemstring

The name of the check item.

passwordExpire
CheckIdlong

The ID of the check item.

2546
Levelstring

The risk level of the risk item. Valid values:

  • high
  • medium
  • low
high
Reasonstring

The description of the check item.

ignore
FixStatusinteger

The fixing status of the check item. Valid values:

  • 0: disabled
  • 1: enabled
0
ExecErrorMessagestring

The error message in check result.

ScriptKilledOfCpuHigh

Example

Normal return example

JSONFormat

{
  "CurrentPage": 1,
  "PageSize": 20,
  "RequestId": "0DFCADBA-7065-42DA-AF17-6868B9C2A8CF",
  "TotalCount": 100,
  "Count": 10,
  "CheckWarnings": [
    {
      "Status": 1,
      "CheckWarningId": 212251441,
      "Type": "hc.check.type.identity_auth",
      "Uuid": "d42f938c-d962-48a0-90f9-****",
      "Item": "passwordExpire",
      "CheckId": 2546,
      "Level": "high",
      "Reason": "ignore",
      "FixStatus": 0,
      "ExecErrorMessage": "ScriptKilledOfCpuHigh"
    }
  ]
}

Error codes

Http codeError codeError messageDescription
400UnknownErrorUnknownError-
400ConsoleErrorThe error message is %s %s.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the API error center.