tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRepositories

Last updated: 2024-12-02 15:03:18

    1. API Description

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

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

    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: DescribeRepositories.
    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 No String Specified namespace. If this parameter is left empty, image repositories in all namespaces will be queried.
    RepositoryName No String Specified image repository. If this parameter is left empty, all image repositories in the specified namespace will be queried.
    Offset No Integer Page number, which is used for pagination
    Limit No Integer Number of entries per page, which is used for pagination
    SortBy No String Sort field. Valid values: -creation_time, -name, -update_time.

    3. Output Parameters

    Parameter Name Type Description
    RepositoryList Array of TcrRepositoryInfo Repository information list
    TotalCount Integer Total number
    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 image repository information

    This example shows you how to query all image repositories in the specified instance.

    Input Example

    https://tcr.intl.tencentcloudapi.com/?Action=DescribeRepositories
&RegistryId=tcr-f7g1ir99
&Limit=20
&Offset=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "772e3357-0b31-4b79-8afb-5b9835a3ada9",
        "RepositoryList": [
            {
                "Name": "mytest/tianzichen",
                "Namespace": "mytest",
                "CreationTime": "2020-02-27 01:07:14.503709 +0800 CST",
                "UpdateTime": "2020-02-27 01:07:14.503709 +0800 CST",
                "Public": false,
                "Description": "mytest",
                "BriefDescription": "test"
            }
        ],
        "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.DependenceError Dependency exception.
    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.
    UnsupportedOperation Unsupported operation
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy