You can call this operation to detect container image vulnerabilities.

It may take one to five minutes to complete the detection. After the vulnerability detection is complete, you can call the DescribeImageVulList operation to query the detected image vulnerabilities.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StartImageVulScan

The operation that you want to perform.

Set the value to StartImageVulScan.

ImageInfos String Yes [{'regionId':'cn-shanghai','instanceId':'cri-vgsym2p83eto****','repoId':'xxx','tag':'v1'}]

The information list of the images. You must specify the following fields:

  • regionId: the ID of the region
  • instanceId: the ID of the asset instance
  • repoId: the ID of the image
  • tag: the tag of the image
Lang String No zh

The language of the request and response. Valid values:

  • zh: Chinese
  • en: English

Response parameters

Parameter Type Example Description
RequestId String 722A669A-EFEA-43D9-8FA1-770

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=StartImageVulScan
&ImageInfos=[{'regionId':'cn-shanghai','instanceId':'cri-vgsym2p83eto****','repoId':'xxx','tag':'v1'}]
&<Common request parameters>

Sample success responses

XML format

<StartImageVulScanResponse>
      <requestId>722A669A-EFEA-43D9-8FA1-770CAFE8C797</requestId>
</StartImageVulScanResponse>

JSON format

{
    "requestId":"722A669A-EFEA-43D9-8FA1-770"
}

Error codes

For a list of error codes, visit the API Error Center.