- Updates and Announcements
- User Tutorial
- Product Introduction
- Purchase Guide
- Quick Start
- Operation Guide
- Creating an Enterprise Edition Instance
- Access Configuration
- Manage Image Repository
- Image Distribution
- Image Security
- Synchronization and Replication
- Configuring Image Tag Retention
- Image Cleanup
- DevOps
- OCI Artifacts Management
- Operation Guide for TCR Individual
- Terminating/Returning Instances
- Practical Tutorial
- 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
- CheckInstance
- CheckInstanceName
- CreateImageAccelerationService
- CreateInstanceCustomizedDomain
- CreateInstanceToken
- DeleteImageAccelerateService
- DeleteInstance
- DeleteInstanceCustomizedDomain
- DeleteInstanceToken
- DescribeImageAccelerateService
- DescribeInstanceCustomizedDomain
- DescribeInstanceStatus
- DescribeInstanceToken
- DescribeInstances
- DescribeRegions
- ModifyInstance
- ModifyInstanceToken
- RenewInstance
- CreateInstance
- 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
- Related Agreement
- Contact Us
- Glossary
- Updates and Announcements
- User Tutorial
- Product Introduction
- Purchase Guide
- Quick Start
- Operation Guide
- Creating an Enterprise Edition Instance
- Access Configuration
- Manage Image Repository
- Image Distribution
- Image Security
- Synchronization and Replication
- Configuring Image Tag Retention
- Image Cleanup
- DevOps
- OCI Artifacts Management
- Operation Guide for TCR Individual
- Terminating/Returning Instances
- Practical Tutorial
- 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
- CheckInstance
- CheckInstanceName
- CreateImageAccelerationService
- CreateInstanceCustomizedDomain
- CreateInstanceToken
- DeleteImageAccelerateService
- DeleteInstance
- DeleteInstanceCustomizedDomain
- DeleteInstanceToken
- DescribeImageAccelerateService
- DescribeInstanceCustomizedDomain
- DescribeInstanceStatus
- DescribeInstanceToken
- DescribeInstances
- DescribeRegions
- ModifyInstance
- ModifyInstanceToken
- RenewInstance
- CreateInstance
- 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
- Related Agreement
- Contact Us
- Glossary
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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
Yes
No
Was this page helpful?