tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNamespaces

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

    1. API Description

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

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

    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: DescribeNamespaces.
    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, all namespaces will be queried.
    Limit No Integer Number of entries per page
    Offset No Integer Page offset (page number from which to return the results)
    All No Boolean Whether to list all namespaces
    Filters.N No Array of Filter Filters
    KmsSignPolicy No Boolean Whether to query only namespaces for which the KMS image signature is enabled

    3. Output Parameters

    Parameter Name Type Description
    NamespaceList Array of TcrNamespaceInfo List of namespaces
    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 namespace information

    This example shows you how to query the information of all namespaces in an instance.

    Input Example

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

{
    "Limit": "20",
    "RegistryId": "tcr-f7g1ir99",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "NamespaceList": [
            {
                "NamespaceId": 2,
                "TagSpecification": {
                    "ResourceType": "namespace",
                    "Tags": [
                        {
                            "Value": "tag-value",
                            "Key": "tag-key"
                        }
                    ]
                },
                "CreationTime": "2020-09-22T00:00:00+00:00",
                "Public": true,
                "Name": "ns"
            },
            {
                "Public": true,
                "Name": "ns1",
                "CreationTime": "2020-09-22T00:00:00+00:00",
                "NamespaceId": 1,
                "TagSpecification": {
                    "ResourceType": "namespace",
                    "Tags": [
                        {
                            "Value": "tag-value",
                            "Key": "tag-key"
                        }
                    ]
                }
            }
        ],
        "TotalCount": 2,
        "RequestId": "866bda78-ed75-4b10-8876-e82de555f69b"
    }
}

    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.ErrorGetDBDataError An error occurred while obtaining the database data.
    FailedOperation.ErrorTcrResourceConflict TCR instance resource conflict.
    FailedOperation.ErrorTcrUnauthorized No permission for TCR operation.
    FailedOperation.GetDBDataError An error occurs while obtaining the database data.
    FailedOperation.OperationCancel The operation is canceled.
    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