tencent cloud

All product documents
容器安全服务
Documentation容器安全服务API DocumentationImage Security APIsDescribeVulRegistryImageList
DescribeVulRegistryImageList
Download PDF
Last updated: 2024-12-06 15:48:09
DescribeVulRegistryImageList
Last updated: 2024-12-06 15:48:09
Download PDF

1. API Description

Domain name for API request: tcss.intl.tencentcloudapi.com.

This API is used to query the list of repository images affected by vulnerabilities.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeVulRegistryImageList.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.
PocID Yes String Vulnerability ID
Limit No Integer The number of results returned. Default value: 10. Maximum value: 100.
Offset No Integer
Filters.N No Array of AssetFilters Filter condition
OnlyAffectedNewestImage: (bool) Whether the latest image is affected.
ImageDigest: Image digest. Fuzzy query is supported.
ImageId: Image ID.
Namespace: Namespace. Fuzzy query is supported.
ImageTag: Image tag. Fuzzy query is supported.
InstanceName: Instance name. Fuzzy query is supported.
ImageName: Image name. Fuzzy query is supported.
ImageRepoAddress: Image address. Fuzzy query is supported.
Order No String Sorting order
By No String Sorting field

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of images
List Array of VulAffectedRegistryImageInfo
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the list of repository images affected by vulnerabilities

Input Example

https://tcss.intl.tencentcloudapi.com/?Action=DescribeVulRegistryImageList
&PocID=1
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 0,
        "List": [
            {
                "ComponentList": [
                    {
                        "Path": "xx",
                        "Version": "xx",
                        "Name": "xx",
                        "FixedVersion": "xx"
                    }
                ],
                "ImageTag": "xx",
                "ImageRepoAddress": "xx",
                "Namespace": "xx",
                "ImageName": "xx",
                "ImageID": "xx",
                "IsLatestImage": true
            }
        ],
        "RequestId": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure A CAM signature/authentication error occurred.
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidFormat The parameter format is incorrect.
InvalidParameter.MissingParameter The required parameter is missing.
InvalidParameter.ParsingError A parameter parsing error occurred.
MissingParameter The parameter is missing.
ResourceNotFound The resource does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
中国香港
+852 800 906 020 (免费)
美国
+1 844 606 0804 (免费)
英国
+44 808 196 4551 (免费)
加拿大
+1 888 605 7930 (免费)
澳大利亚
+61 1300 986 386 (免费)
EdgeOne 热线
+852 300 80699
更多本地服务热线陆续新增中