SwitchProxy

下载PDF

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

SwitchProxy

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

下载PDF

1. API Description

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

This API is used to simulate the fault of a Proxy node.

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.

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: SwitchProxy.
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.
ProxyID	No	String	Proxy ID of an instance, which can be obtained through NodeId of the response parameter Proxy of the API DescribeInstanceNodeInfo.
ProxyIDList.N	No	Array of String	Instance proxy ID list. Call the API DescribeInstanceNodeInfo to obtain IDs from NodeId in the Proxy response parameter.

3. Output Parameters

Parameter Name	Type	Description
TaskId	Integer	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 Request Example

Input Example

https://redis.intl.tencentcloudapi.com/?Action=SwitchProxy
&InstanceId=crs-5a4py64p
&<Common request parameters>

Output Example

{
    "Response": {
        "TaskId": 1378445,
        "RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4"
    }
}

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
AuthFailure	CAM signature/authentication error.
FailedOperation.SystemError	Internal system error, which is irrelevant to the business.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
ResourceNotFound.InstanceNotExists	No Redis instance is found by the serialId.

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

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

是

否

文档反馈

tencent cloud