tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstanceToken

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

    1. API Description

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

    This API is used to update the status of the specified long-term access credential in an 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: ModifyInstanceToken.
    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.
    TokenId Yes String ID of the long-term access credential of the instance
    RegistryId Yes String Instance ID
    Enable No Boolean Whether to enable the long-term access credential of the instance
    Desc No String Access credential description
    ModifyFlag No Integer Valid values: 1: Modify the description; 2: Enable/Disable. Default value: 2.

    3. Output Parameters

    Parameter Name Type Description
    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 Enabling a long-term access credential of an instance

    Input Example

    https://tcr.tencentcloudapi.com/?Action=ModifyInstanceToken
&RegistryId=tcr-12345
&TokenId=2ab3af0d-893d-423f-91b1-27713566f95f
&Enable=true
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6cd302c6-c4c9-425a-8d07-8c59b7f4cf3f"
    }
}

    Example2 Disabling a long-term access credential of an instance

    Input Example

    https://tcr.tencentcloudapi.com/?Action=ModifyInstanceToken
&RegistryId=tcr-12345
&TokenId=2ab3af0d-893d-423f-91b1-27713566f95f
&Enable=false
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6cd302c6-c4c9-425a-8d07-8c59b7f4cf3f"
    }
}

    Example3 Updating the description

    Input Example

    https://tcr.tencentcloudapi.com/?Action=ModifyInstanceToken
&RegistryId=tcr-12345
&TokenId=2ab3af0d-893d-423f-91b1-27713566f95f
&Desc=aaa
&ModifyFlag=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6cd302c6-c4c9-425a-8d07-8c59b7f4cf3f"
    }
}

    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.
    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