tencent cloud

All product documents
Tencent Container Security Service
DocumentationTencent Container Security ServiceAPI DocumentationImage Security APIsDescribeAssetImageDetail
DescribeAssetImageDetail
Download PDF
Last updated: 2024-12-06 15:48:39
DescribeAssetImageDetail
Last updated: 2024-12-06 15:48:39
Download PDF

1. API Description

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

This API is used to query the details of an image.

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: DescribeAssetImageDetail.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.
ImageID Yes String Image ID

3. Output Parameters

Parameter Name Type Description
ImageID String Image ID
ImageName String Image name
CreateTime String Creation time
Size Integer Image size
HostCnt Integer Number of associated servers
Note: This field may return null, indicating that no valid values can be obtained.
ContainerCnt Integer Number of associated containers
Note: This field may return null, indicating that no valid values can be obtained.
ScanTime String Last scan time
Note: This field may return null, indicating that no valid values can be obtained.
VulCnt Integer Number of vulnerabilities
Note: This field may return null, indicating that no valid values can be obtained.
RiskCnt Integer Number of risky behaviors
Note: This field may return null, indicating that no valid values can be obtained.
SensitiveInfoCnt Integer Number of sensitive data items
Note: This field may return null, indicating that no valid values can be obtained.
IsTrustImage Boolean Whether it is a trusted image
OsName String Image system
AgentError String Image scan error in the agent
Note: This field may return null, indicating that no valid values can be obtained.
ScanError String Image scan error on the backend
Note: This field may return null, indicating that no valid values can be obtained.
Architecture String System architecture
Note: This field may return null, indicating that no valid values can be obtained.
Author String Author
Note: This field may return null, indicating that no valid values can be obtained.
BuildHistory String Build history
Note: This field may return null, indicating that no valid values can be obtained.
ScanVirusProgress Integer Trojan scanning progress
Note: This field may return null, indicating that no valid values can be obtained.
ScanVulProgress Integer Vulnerability scan progress
Note: This field may return null, indicating that no valid values can be obtained.
ScanRiskProgress Integer Sensitive data scanning progress
Note: This field may return null, indicating that no valid values can be obtained.
ScanVirusError String Trojan scan error
Note: This field may return null, indicating that no valid values can be obtained.
ScanVulError String Vulnerability scan error
Note: This field may return null, indicating that no valid values can be obtained.
ScanRiskError String Sensitive data error
Note: This field may return null, indicating that no valid values can be obtained.
ScanStatus String Image scanning status
Note: This field may return null, indicating that no valid values can be obtained.
VirusCnt Integer Number of viruses and trojans
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Image scanning status
Note: This field may return null, indicating that no valid values can be obtained.
RemainScanTime Integer Remaining scan time
Note: This field may return null, indicating that no valid values can be obtained.
IsAuthorized Integer Valid values: 1 (licensed); 0 (unlicensed).
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 details of an image

This example shows you how to query the details of an image.

Input Example

POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageDetail
<Common request parameters>

{
    "ImageID": "dskaldjskld"
}

Output Example

{
    "Response": {
        "AgentError": "",
        "Architecture": "",
        "Author": "",
        "BuildHistory": "file:c92c248239f8c7b9b3c067650954815f391b7bcb09023f984972c082ace2a8d0 in  ",
        "ContainerCnt": 0,
        "CreateTime": "2021-01-29T04:03:11Z",
        "HostCnt": 1,
        "ImageID": "sha256:1c19ee40bfafd313400cde57a50b38b16ed4751c6b62a64141f18629a0e9d430",
        "ImageName": "<none>:<none>",
        "IsTrustImage": true,
        "OsName": "alpine:v3.12",
        "RemainScanTime": 0,
        "RequestId": "1d1ca0b5-f2ca-40bb-8797-39132bdbf35e",
        "RiskCnt": 7,
        "ScanError": "",
        "ScanRiskError": "",
        "ScanRiskProgress": 100,
        "ScanStatus": "SCAN_ERR",
        "ScanTime": "2021-01-29T05:26:18.07Z",
        "ScanVirusError": "Failed",
        "ScanVirusProgress": 100,
        "ScanVulError": "",
        "ScanVulProgress": 100,
        "SensitiveInfoCnt": 0,
        "Size": 16159906,
        "Status": 3,
        "VirusCnt": 11,
        "VulCnt": 5,
        "IsAuthorized": 0
    }
}

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
InternalError An internal error occurred.
InternalError.MainDBFail The database operation failed.
InvalidParameter The parameter is incorrect.
InvalidParameter.ParsingError A parameter parsing error occurred.
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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon