All Products
Search

This Product

    Security Center:DescribeCheckWarningSummary

    Document Center

    Security Center:DescribeCheckWarningSummary

    Last Updated:Feb 20, 2024

    Queries the statistical information about baseline check results. The information includes the number of servers on which a baseline check is performed, the number of baseline check items, and the pass rate of check items in the last baseline check.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SourceIpstringNo

    The source IP address of the request.

    		219.133.XX.XX
    LangstringNo

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

    • zh: Chinese
    • en: English
    		zh
    TypeNamestringNo

    The level-1 type of check items.

    Note You can call the DescribeRiskType operation to query the level-1 types of check items.
    		database
    StatusstringNo

    The status of the check item. Valid values:

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

    The status of the baseline check. Valid values:

    • 1: failed
    • 3: passed
    		1
    RiskNamestringNo

    The name of the risk item.

    		Redis
    StrategyIdlongNo

    The ID of the baseline check policy.

    		1
    UuidsstringNo

    The UUID of the asset.

    Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of assets.
    		f03259d8-1e81-4fae-bcbb-275fb5****
    PageSizeintegerNo

    The number of entries to return on each page.

    		10
    CurrentPageintegerNo

    The number of the page to return.

    		1
    ClusterIdstringNo

    The ID of the container cluster.

    Note You can call the DescribeGroupedContainerInstances operation to query the IDs of container clusters.
    		c80dae73bd1be442699766b14ffd0****
    ContainerFieldNamestringNo

    The name of the container field. Valid values:

    • clusterId: the ID of the cluster
    • image: the name of the image
    • imageId: the ID of the image
    • namespace: the namespace
    		namespace
    ContainerFieldValuestringNo

    The value of the container field.

    		c819391d2d520485fa3e81e2dc2ea****
    TargetTypestringNo

    The type of the query condition. Valid values:

    • uuid: the ID of an asset
    		uuid
    GroupIdlongNo

    The ID of the asset group.

    Note You can call the DescribeAllGroups operation to query the IDs of asset groups.
    		123

    Response parameters

    ParameterTypeDescriptionExample
    object
    CurrentPageinteger

    The page number of the current page.

    		1
    PageSizeinteger

    The number of entries to return on each page.

    		10
    RequestIdstring

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

    		00BD7CE2-284A-4534-BD09-FB69836DD750
    TotalCountinteger

    The total number of check items.

    		100
    Countinteger

    The number of check items returned on the current page.

    		10
    WarningSummarysobject []

    The statistics of check items.

    LowWarningCountinteger

    The number of low-risk items.

    		3
    CheckCountinteger

    The number of check items.

    		10
    MediumWarningCountinteger

    The number of medium-risk items.

    		2
    LastFoundTimestring

    The time when the last baseline check was performed.

    		2019-01-01 12:23:00
    RiskIdlong

    The ID of the risk item.

    		118
    SubTypeAliasstring

    The level-2 type of the risk item.

    		Redis
    WarningMachineCountinteger

    The number of assets on which risk items are detected.

    		11
    HighWarningCountinteger

    The number of high-risk items.

    		1
    TypeAliasstring

    The level-1 type of the check item. Examples: database, system, weak password, and middleware.

    		databases
    RiskNamestring

    The name of the risk item.

    		Redis
    Levelstring

    The risk level of the risk item. Valid values:

    • high
    • medium
    • low
    		high
    CheckExploitboolean

    Indicates whether the risk item can be exploited. Valid values:

    • true: yes
    • false: no
    		false
    DatabaseRiskboolean

    Indicates whether the risk item is a database risk item. Valid values:

    • true: yes
    • false: no
    		false
    ContainerRiskboolean

    Indicates whether the risk item is a container runtime risk item. Valid values:

    • true: yes
    • false: no
    		false

    Examples

    Sample success responses

    JSONformat

    {
  "CurrentPage": 1,
  "PageSize": 10,
  "RequestId": "00BD7CE2-284A-4534-BD09-FB69836DD750",
  "TotalCount": 100,
  "Count": 10,
  "WarningSummarys": [
    {
      "LowWarningCount": 3,
      "CheckCount": 10,
      "MediumWarningCount": 2,
      "LastFoundTime": "2019-01-01 12:23:00",
      "RiskId": 118,
      "SubTypeAlias": "Redis",
      "WarningMachineCount": 11,
      "HighWarningCount": 1,
      "TypeAlias": "databases",
      "RiskName": "Redis",
      "Level": "high",
      "CheckExploit": false,
      "DatabaseRisk": false,
      "ContainerRisk": false
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermissionno permission-
    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 Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-03-22The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 500
    Output ParametersThe response structure of the API has changed.