tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeImages

Last updated: 2024-03-21 17:45:46

    1. API Description

    Domain name for API request: tcr.tencentcloudapi.com.

    This API is used to query the list of image tags or the information of the specified container image.

    A maximum of 100 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: DescribeImages.
    Version Yes String Common Params. The value used for this API: 2019-09-24.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    RegistryId Yes String Instance ID
    NamespaceName Yes String Namespace name
    RepositoryName Yes String Image repository name
    ImageVersion No String Image tag specified for fuzzy search
    Limit No Integer Number of entries per page, which is used for pagination. Default value: 20.
    Offset No Integer Page number. Default value: 1.
    Digest No String Image digest specified for search
    ExactMatch No Boolean Whether to use exact matching. Valid values: true (exact matching), null (fuzzy matching).

    3. Output Parameters

    Parameter Name Type Description
    ImageInfoList Array of TcrImageInfo List of container images
    TotalCount Integer Total number of container images
    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 information of a container image

    This example shows you how to query the information of all container images in the specified image repository and get the list of image tags.

    Input Example

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

{
    "Limit": "20",
    "NamespaceName": "team-01",
    "RepositoryName": "nginx",
    "RegistryId": "tcr-okmj78",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "RequestId": "d76f7a1b-d9e9-4454-b95b-25c34f17b943",
        "ImageInfoList": [
            {
                "Digest": "sha256:a1801b843b1bfaf77c501e7a6d3f709401a1e0c83863037fa3aab063a7fdb9dc",
                "ImageVersion": "8",
                "Size": 83520757,
                "UpdateTime": "2022-08-06T07:31:01.207374Z",
                "Kind": "Artifact::application/vnd.docker.distribution.manifest.v2+json",
                "KmsSignature": "UKauWpHdjaTjTsE64BSFhJe0YZj7eXiu8DzkRgTk0vbuxl+ICYbVJ2p1afHGv/WsOqqJvEKJdNPU4iAGNYEbegTi/UwcrCRijNeFkzHNqljBa75g1u9LHjVmtE9dxzh17YGRHpDxbL2CCjZ9YgeCqppsl1LiXvlYdrMLgoqwHKwao3WnkZU2fye4HIreZ3CXGkjv7g8rbhmjwEZJUTWAuEws7eNSvl9RS8NAJctwvZWZQUGKkRpbBRkKxdENSIgRoA+SyX0Qmu2SxvwDRTsCwI+B1rJxLmw1wYgAh3mQiXtehBZAJdYLcOvokUgAUC8cpKpeJ+bSsYvCLh+uJlF4Pg=="
            }
        ],
        "TotalCount": 1
    }
}

    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
    FailedOperation Operation failed
    FailedOperation.EmptyCoreBody A null is returned for Core.
    InternalError Internal error. Please check and try again.
    InternalError.DbError Database error. Please check and try again.
    InternalError.ErrorTcrInternal Internal error with the TCR instance.
    InternalError.ErrorTcrInvalidMediaType Invalid request header
    InternalError.ErrorTcrResourceConflict TCR instance resource conflict.
    InternalError.ErrorTcrUnauthorized No permission for TCR operation.
    InvalidParameter Parameter error. Please check and try again.
    InvalidParameter.ErrorTcrInvalidParameter Invalid TCR request.
    MissingParameter Missing parameters. Please check and try again.
    OperationDenied Operation denied.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.TcrResourceNotFound The resource of the TCR instance was not found.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy