tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateInstanceToken

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

    1. API Description

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

    This API is used to create a temporary or long-term instance access credential.

    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: CreateInstanceToken.
    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
    TokenType No String Access credential type. Values: longterm and temp (default, valid for one hour)
    Desc No String Description of the long-term access credential

    3. Output Parameters

    Parameter Name Type Description
    Username String Username
    Note: this field may return null, indicating that no valid value can be found.
    Token String Access credential
    ExpTime Integer Expiration timestamp of access credential. It is a string of numbers without unit.
    TokenId String Token ID of long-term access credential. It is not available to temporary access credential.
    Note: this field may return null, indicating that no valid value can be found.
    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 Obtaining a temporary instance access credential

    This example shows you how to obtain a temporary instance access credential, of which the valid period is one hour.

    Input Example

    https://tcr.tencentcloudapi.com/?Action=CreateInstanceToken
&RegistryId=tcr-ak9876
&TokenType=temp
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Username": 12345678,
        "Token": "XXXX",
        "ExpTime": "33987631",
        "RequestId": "xx",
        "TokenId": "xx"
    }
}

    Example2 Obtaining a long-term instance access credential

    This example shows you how to obtain a long-term instance access credential, which can be used to grant permissions to third-party applications.

    Input Example

    https://tcr.tencentcloudapi.com/?Action=CreateInstanceToken
&RegistryId=tcr-ak9876
&TokenType=longterm
&Desc=for-tke-cluster
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Username": 12345678,
        "Token": "XXXX",
        "ExpTime": "33987631",
        "RequestId": "xx",
        "TokenId": "1456976"
    }
}

    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.Unknown Unknown error.
    InvalidParameter Parameter error. Please check and try again.
    ResourceNotFound.TcrResourceNotFound The resource of the TCR instance was not found.
    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