All Products
Search
Document Center

Security Center:DescribeGroupedMaliciousFiles

Last Updated:Jan 28, 2023

Queries malicious image samples.

Authorization information

There is currently no authorization information disclosed in the API.

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.

NoteFuzzy 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)
  • ap-south-1: India (Mumbai)
cn-shanghai
RepoInstanceIdstringNo

The ID of the container image.

NoteYou 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.

NoteYou 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.

NoteFuzzy match is supported.
centos
RepoNamespacestringNo

The namespace to which the image repository belongs.

NoteFuzzy 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

Response parameters

ParameterTypeDescriptionExample
object
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

An array that consists of the malicious image samples.

object

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: added to the whitelist
0
ImageCountlong

The number of affected images.

3
LatestScanTimestamplong

The timestamp 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 when the first scan was performed. Unit: milliseconds.

1594907349000
Levelstring

The severity of the malicious image sample. Valid values:

  • serious
  • suspicious
  • remind
serious

Example

Normal return example

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"
    }
  ]
}

Error codes

Http codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperate
2022-09-16The input parameters of the API operation has changed
Change itemChange content
Input ParametersThe input parameters of the API operation has changed
    Added Input Parameters: ScanRange
2022-09-16The input parameters of the API operation has changed
Change itemChange content
Input ParametersThe input parameters of the API operation has changed
    Added Input Parameters: ScanRange