ModifyInstance

Last updated: 2019-12-05 19:02:05

PDF

1. API Description

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

This API is used to modify instance information (renaming an instance is supported currently).

A maximum of 50 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyInstance
Version Yes String Common parameter. The value used for this API: 2018-04-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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
InstanceId No String Instance ID
InstanceName No String New name of an instance
ProjectId No Integer Project ID
AutoRenew No Integer Auto-renewal flag. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabled

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Request Sample

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

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList The user is not in the whitelist.
UnsupportedOperation.ClusterInstanceAccessedDeny The Redis cluster edition is not allowed to connect to a security group.
UnsupportedOperation.IsAutoRenewError Auto-renewal flag error.
UnsupportedOperation.OnlyClusterInstanceCanExportBackup Only cluster edition instances support backup exporting.