tencent cloud

Tencent Container Registry

Release Notes and Announcements
Release Notes
Announcements
User Tutorial
Product Introduction
Overview
TCR Service Levels and Capacity Limits
Strengths
Scenarios
Purchase Guide
Billing Overview
Purchase Methods
Notes on Arrears
Getting Started
Quick Start
TCR Individual Getting Started
Operation Guide
Creating an Enterprise Edition Instance
Access Configuration
Manage Image Repository
Image Distribution
Image Security
Image Cleanup
DevOps
OCI Artifacts Management
Operation Guide for TCR Individual
Terminating/Returning Instances
Use Cases
TCR Personal migration
TKE Clusters Use the TCR Addon to Enable Secret-free Pulling of Container Images via Private Network
Synchronizing Images to TCR Enterprise Edition from External Harbor
TKE Serverless Clusters Pull TCR Container Images
Image Data Synchronization and Replication Between Multiple Platforms in Hybrid Cloud
Nearby Access Through Image Synchronization Between Multiple Global Regions
Using Custom Domain Name and CCN to Implement Cross-Region Private Network Access
API Documentation
History
Introduction
API Category
Making API Requests
Instance Management APIs
Namespace APIs
Access Control APIs
Instance Synchronization APIs
Tag Retention APIs
Trigger APIs
Helm Chart APIs
Image Repository APIs
Custom Account APIs
Data Types
Error Codes
FAQs
TCR Individual Edition
TCR Enterprise Edition
Related Agreement
Service Level Agreement
Contact Us
Glossary
DocumentaçãoTencent Container RegistryAPI DocumentationInstance Management APIsDescribeInstances

DescribeInstances

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2025-10-30 21:58:13

1. API Description

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

This API is used to query the instance information.

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: DescribeInstances.
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.
Registryids.N No Array of String List of instance IDs (if it is empty,
it indicates to get all instances under the current account)
Offset No Integer Offset. Default value: 0.
Limit No Integer Maximum number of output entries. Default value: 20. Maximum value: 100.
Filters.N No Array of Filter Filters
AllRegion No Boolean Whether to get the instances in all regions. Default value: False.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of instances
Registries Array of Registry List of instances
Note: This field may return null, indicating that no valid values can be obtained.
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 Viewing the list of instances

Input Example

https://tcr.intl.tencentcloudapi.com/?Action=DescribeInstances
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Registries": [
            {
                "RegistryId": "cls-xxxxxxx",
                "RegistryName": "aaa",
                "Status": "Running",
                "RegistryType": "standard",
                "PublicDomain": "mytest.tencentcloudcr.com",
                "InternalEndpoint": "8.9.10.9",
                "ExpiredAt": "2020-09-10",
                "PayMod": 1,
                "RenewFlag": 1
            }
        ],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}

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
InternalError Internal error. Please check and try again.
InternalError.DbError Database error. Please check and try again.
InvalidParameter Parameter error. Please check and try again.
MissingParameter Missing parameters. Please check and try again.
OperationDenied Operation denied.
ResourceInsufficient.ErrorInstanceNotRunning Exceptional instance status.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter error. Please check and try again.
UnsupportedOperation Unsupported operation
Anterior: DescribeInstanceTokenPróximo: DescribeRegions

Ajuda e Suporte

Esta página foi útil?

comentários