ModifyInstance

下载PDF

最后更新时间：2025-10-28 22:21:53

ModifyInstance

最后更新时间： 2025-10-28 22:21:53

下载PDF

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 an instance. - modifyProject: modify the project to which the instance belongs. - modifyAutoRenew: modify the instance renewal flag. - modifyDeleteProtectionSwitch: modify the instance deletion protection switch status.
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. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.
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.
DeleteProtectionSwitches.N	No	Array of Integer	Deletion protection switch. - 0: disabled by default; - 1: enabled.

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

Tencent Cloud CLI 3.0

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.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud