tencent cloud

容器镜像服务

动态与公告
产品动态
产品公告
新手指引
产品简介
产品概述
产品服务层级与容量限制
产品优势
应用场景
购买指南
计费概述
购买方式
欠费说明
快速入门
企业版快速入门
个人版快速入门
操作指南
创建企业版实例
访问配置
镜像创建
镜像分发
镜像安全
镜像清理
DevOps
OCI 制品管理
个人版操作指南
销毁退还实例
实践教程
个人版迁移
TKE 集群使用 TCR 插件内网免密拉取容器镜像
从自建 Harbor 同步镜像到 TCR 企业版
TKE Serverless 集群拉取 TCR 容器镜像
混合云下的多平台镜像数据同步复制
全球多地域间同步镜像实现就近访问
使用自定义域名及云联网实现跨地域内网访问
API 文档
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
常见问题
容器镜像服务个人版
容器镜像服务企业版
相关协议
Service Level Agreement
联系我们
词汇表

CheckInstance

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:58:18

1. API Description

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

This API is used to verify the information of the Enterprise Edition instance.

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: CheckInstance.
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 ID of the instance to be verified.

3. Output Parameters

Parameter Name Type Description
IsValidated Boolean Verification result. true: valid, false: invalid
RegionId Integer ID of the region where the instance is located.
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 Checking whether the instance ID exists

Input Example

https://tcr.intl.tencentcloudapi.com/?Action=CheckInstance
&RegistryId=tcr-test
&<Common request parameters>

Output Example

{
    "Response": {
        "IsValidated": true,
        "RegionId": 1,
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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.DependenceError Dependency exception.
InternalError Internal error. Please check and try again.
InternalError.DbError Database error. Please check and try again.
InternalError.ErrConflict Target conflicts.
InternalError.ErrNotExist The target does not exist.
InternalError.ErrorConflict The resource already exists.
InternalError.ErrorOverLimit The resource quota is exceeded.
InvalidParameter Parameter error. Please check and try again.
InvalidParameter.ErrorNameExists The instance name already exists.
InvalidParameter.ErrorRegistryName Invalid instance name. Its format is incorrect or it has been reserved.
InvalidParameter.ErrorTagOverLimit The instance can bind up to 10 Tencent Cloud tags.
InvalidParameter.UnsupportedRegion Creating instance is not supported in this region.
MissingParameter Missing parameters. Please check and try again.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter error. Please check and try again.
UnsupportedOperation Unsupported operation

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈