1. API Description
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to upgrade the instance Proxy version.
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.
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: UpgradeProxyVersion. |
| 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. |
| InstanceId |
Yes |
String |
Instance ID. Log in to the Redis console and copy it in the instance list. |
| CurrentProxyVersion |
Yes |
String |
Current proxy version. Call the DescribeInstances API to obtain the current proxy version for the instance. |
| UpgradeProxyVersion |
Yes |
String |
Upgradable Redis version. Call the DescribeInstances API to obtain the upgradable Redis version for the instance. |
| InstanceTypeUpgradeNow |
Yes |
Integer |
Specifies whether to upgrade immediately. - 1: Upgrade immediately. - 0: Upgrade during the maintenance window. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| FlowId |
Integer |
Async task ID |
| 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 Upgrading instance proxy
https:
&InstanceId=crs-94w4mqbt
&CurrentProxyVersion=4.1.1
&UpgradeProxyVersion=4.3.0
&InstanceTypeUpgradeNow=1
&<Common request parameters>
Output Example
{
"Response": {
"FlowId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"
}
}
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. |
| InvalidParameterValue.CheckNotPass |
Business verification failed |