tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstance

Last updated: 2024-04-03 11:33:06

    1. API Description

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

    This API is used to modify instance information.

    A maximum of 50 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: ModifyInstance.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    Operation Yes String Instance modification type. rename: rename an instance; modifyProject: modify the project of an instance; modifyAutoRenew: modify the auto-renewal flag of an instance.
    InstanceIds.N No Array of String Instance ID
    InstanceNames.N No Array of String New name of the instance
    ProjectId No Integer Project ID
    AutoRenews.N No Array of Integer Auto-renewal flag. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabled
    InstanceId No String Disused
    InstanceName No String Disused
    AutoRenew No Integer Disused

    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 Sample request

    Input Example

    https://redis.tencentcloudapi.com/?Action=ModifyInstance
&Operation=rename
&InstanceIds.0=crs-r3nqjq3n
&InstanceNames.0=newname1
&InstanceIds.1=crs-9bvd9b8v
&InstanceNames.1=newname2
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6d1e8909-496a-4f27-ad0d-2e4a069b52c0"
    }
}

    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.SystemError Internal system error, which is irrelevant to the business.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.NoCAMAuthed No CAM permissions.
    UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
    UnsupportedOperation.ClusterInstanceAccessedDeny The Redis cluster edition is not allowed to connect to a security group.
    UnsupportedOperation.IsAutoRenewError There is an error with the auto-renewal flag.
    UnsupportedOperation.OnlyClusterInstanceCanExportBackup Only Cluster Edition instances support backup exporting.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy