tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CheckInstanceName

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

    1. API Description

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

    This API is used to check whether the name of the instance to be created meets the specifications.

    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: CheckInstanceName.
    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.
    RegistryName Yes String Name of the instance to be created

    3. Output Parameters

    Parameter Name Type Description
    IsValidated Boolean Verification result. Valid values: true: Valid; false: Invalid.
    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 name of the instance to be created meets the specifications

    Input Example

    https://tcr.tencentcloudapi.com/?Action=CheckInstanceName
&RegistryName=registryName123
&<Common request parameters>

    Output Example

    {
    "Response": {
        "IsValidated": true,
        "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
    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
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy