All Products
Search

This Product

    Security Center:DescribeGroupedMaliciousFiles

    Document Center

    Security Center:DescribeGroupedMaliciousFiles

    Last Updated:Nov 25, 2024

    Queries a list of malicious image samples.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    LangstringNo

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

    • zh: Chinese
    • en: English
    		zh
    LevelsstringNo

    The severity of the malicious image sample that you want to query. You can enter multiple severities. Separate the severities with commas (,). Valid values:

    • serious
    • suspicious
    • remind
    		serious
    FuzzyMaliciousNamestringNo

    The name of the malicious image sample that you want to query.

    Note Fuzzy match is supported.
    		Mining
    CurrentPageintegerYes

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

    		1
    PageSizestringYes

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

    		20
    RepoRegionIdstringNo

    The region ID of the image repository. Valid values:

    • cn-beijing: China (Beijing)
    • cn-zhangjiakou: China (Zhangjiakou)
    • cn-hangzhou: China (Hangzhou)
    • cn-shanghai: China (Shanghai)
    • cn-shenzhen: China (Shenzhen)
    • cn-hongkong: China (Hong Kong)
    • ap-southeast-1: Singapore
    • ap-southeast-5: Indonesia (Jakarta)
    • us-east-1: US (Virginia)
    • us-west-1: US (Silicon Valley)
    • eu-central-1: Germany (Frankfurt)
    • eu-west-1: UK (London)
    		cn-shanghai
    RepoInstanceIdstringNo

    The ID of the container image.

    Note You can call the ListRepository operation to query the IDs of container images from the value of the InstanceId response parameter.
    		cri-datvailb****
    RepoIdstringNo

    The ID of the image repository.

    Note You can call the ListRepository operation to query the IDs of image repositories from the value of the RepoId response parameter.
    		crr-vridcl4****
    RepoNamestringNo

    The name of the image repository.

    Note Fuzzy match is supported.
    		centos
    RepoNamespacestringNo

    The namespace to which the image repository belongs.

    Note Fuzzy match is supported.
    		hanghai-namespace
    ImageTagstringNo

    The image tag.

    		0.2
    ImageDigeststringNo

    The image digest.

    		6a5e103187b31a94592a47a5858617f7****
    ImageLayerstringNo

    The image layer.

    		27213ad375b53628dd152a5ca****
    ClusterIdstringNo

    The cluster ID of the container on which the malicious image sample is detected.

    		c556c8133b5ad4378b7fc533ddbda****
    ScanRangearrayNo

    The types of the assets that you want to scan.

    stringNo

    The type of the asset that you want to scan. Valid values:

    • container
    • image
    		container
    MaliciousMd5stringNo

    The MD5 hash value of the malicious image sample.

    		d836968041f7683b5459****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

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

    		8045E03E-6D91-4C53-9F22-5A1B84BB29D9
    PageInfoobject

    The pagination information.

    CurrentPageinteger

    The page number of the returned page.

    		1
    PageSizeinteger

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

    		20
    TotalCountinteger

    The total number of entries returned.

    		2
    Countinteger

    The number of entries returned on the current page.

    		2
    GroupedMaliciousFileResponsearray<object>

    The details of the malicious image sample.

    GroupedMaliciousFileobject

    The information about the malicious image sample.

    Statusinteger

    The handling status of the malicious image sample. Valid values:

    • 0: unhandled
    • 1: handled
    • 2: verifying
    • 3: whitelisted
    		0
    ImageCountlong

    The number of affected images.

    		3
    LatestScanTimestamplong

    The timestamp generated when the last scan was performed. Unit: milliseconds.

    		1596533942000
    MaliciousNamestring

    The name of the malicious image sample.

    		testFile
    MaliciousMd5string

    The MD5 hash value of the malicious image sample.

    		d836968041f7683b5459****
    FirstScanTimestamplong

    The timestamp generated when the first scan was performed. Unit: milliseconds.

    		1594907349000
    Levelstring

    The severity of the malicious image sample. Valid values:

    • serious
    • suspicious
    • remind
    		serious
    MaliciousKeystring

    The keyword of the malicious image sample.

    		WEBSHELL_IMG

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "8045E03E-6D91-4C53-9F22-5A1B84BB29D9",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "GroupedMaliciousFileResponse": [
    {
      "Status": 0,
      "ImageCount": 3,
      "LatestScanTimestamp": 1596533942000,
      "MaliciousName": "testFile",
      "MaliciousMd5": "d836968041f7683b5459****",
      "FirstScanTimestamp": 1594907349000,
      "Level": "serious",
      "MaliciousKey": "WEBSHELL_IMG"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    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-10-17The response structure of the API has changedView Change Details
    2022-09-16The request parameters of the API has changedView Change Details
    2022-09-16The request parameters of the API has changedView Change Details