All Products
Search

This Product

    Security Center:DescribeWarningMachines

    Document Center

    Security Center:DescribeWarningMachines

    Last Updated:Nov 25, 2024

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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

    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
    MachineNamestringNo

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

    		oracle-win-001****
    UuidsstringNo

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

    		9888955c-0076-49da-bd9c-34f5492b****
    RiskIdlongYes

    The ID of the risk item.

    Note You can call the DescribeCheckWarningSummary operation to query the IDs of risk items.
    		196
    StrategyIdlongNo

    The ID of the baseline check policy.

    		16
    PageSizeintegerNo

    The number of entries per page. Default value: 10, which indicates that 10 entries of server information are displayed on each page. A maximum of 100 entries can be returned per page.

    		10
    CurrentPageintegerNo

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

    		1
    ClusterIdstringNo

    The ID of the container cluster.

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

    The name of the field that is used to search for the container. Valid values:

    • CONTAINER_ID: the ID of the container
    • IMAGE: the name of the image
    • NAMESPACE: the namespace
    • NODE_NAME: the name of the node
    • POD_IP: the IP address of the pod
    • HOST_IP: the IP address of the host
    • INSTANCE_ID: the ID of the instance
    		containerId
    ContainerFieldValuestringNo

    The value of the field that is used to search for the container.

    		c8bb3ef0f5ccf45508f0fd1ffc200****
    TargetTypestringNo

    The type of the query condition. Valid values:

    • containerId: the ID of the container
    • uuid: the UUID of the asset
    		uuid
    HaveRiskintegerNo

    Specifies whether risks were detected. Valid values:

    • 1: yes
    • 0: no
    		1
    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 returned page.

    		1
    PageSizeinteger

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

    		10
    RequestIdstring

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

    		6E4CBE87-E887-5AF1-86D2-78EB4AA3E771
    TotalCountinteger

    The total number of entries returned.

    		1
    Countinteger

    The number of entries returned on the current page.

    		10
    WarningMachinesarray<object>

    The information about the servers.

    WarningMachineobject
    Statusinteger

    The verification status of the risk item after the risk item is fixed. Valid values:

    • 1: complete
    • 2: verifying
    		1
    InternetIpstring

    The public IP address of the server.

    		1.2.XX.XX
    InstanceIdstring

    The server ID.

    		i-m5ee8b9nr3h30mhb****
    HighWarningCountinteger

    The number of high-risk items on the server.

    		10
    IntranetIpstring

    The private IP address of the server.

    		1.2.XX.XX
    RegionIdstring

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

    		cn-qingdao
    LowWarningCountinteger

    The number of low-risk items on the server.

    		3
    PortOpenboolean

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

    • true
    • false
    		true
    Uuidstring

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

    		9888955c-0076-49da-bd9c-34f5492b****
    MediumWarningCountinteger

    The number of medium-risk items on the server.

    		2
    PassCountinteger

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

    		10
    InstanceNamestring

    The name of the server.

    		oracle-win-00****
    Bindboolean

    Indicates whether Security Center is authorized to protect the asset. Valid values:

    • true
    • false
    		true
    AuthVersioninteger

    The edition of Security Center that is authorized to protect the asset. Valid values:

    • 1: Basic edition
    • 6: Anti-virus edition
    • 5: Advanced edition
    • 3: Enterprise edition
    • 7: Ultimate edition
    • 10: Value-added Plan edition
    		7
    ContainerIdstring

    The container ID.

    		48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******
    ContainerNamestring

    The name of the container.

    		redis

    Examples

    Sample success responses

    JSONformat

    {
  "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****",
      "Bind": true,
      "AuthVersion": 7,
      "ContainerId": "48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******",
      "ContainerName": "redis"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    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 changedView Change Details