tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Instance APIsModifyInstance
ModifyInstance
Last updated: 2024-12-04 11:19:11
ModifyInstance
Last updated: 2024-12-04 11:19:11

1. API Description

Domain name for API request: redis.intl.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 Yes String Common Params. For more information, please see the list of regions supported by the product.
Operation Yes String Instance modification operation. Valid values:
- rename: Rename the instance.
- modifyProject: Modify the project to which the instance belongs.
- modifyAutoRenew: Modify the instance renewal flag.
InstanceIds.N No Array of String Instance ID. Log in to the Redis console and copy it in the instance list. The maximum number of instances per request is 10.
InstanceNames.N No Array of String New name of the instance.
ProjectId No Integer Project ID. Log in to the Project Management page of the Redis console and copy the project ID in Project Name.
AutoRenews.N No Array of Integer Auto-renewal flag.

- 0: default status (manual renewal).
- 1: automatic renewal.
- 2: no automatic renewal.
InstanceId No String This parameter is currently being deprecated and can still be used by existing users. It is recommended that new users use InstanceIds.
InstanceName No String Disused
AutoRenew No Integer This parameter has been deprecated.

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.intl.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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support