Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to create an async task of killing all proxy node connection sessions and is currently supported only for Redis. The async task ID is the returned value, which can be passed to the API DescribeProxySessionKillTasks
as a parameter to query the execution status of the session killing task.
A maximum of 20 requests can be initiated per second for this API.
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: CreateProxySessionKillTask. |
Version | Yes | String | Common Params. The value used for this API: 2021-05-27. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID. |
Product | Yes | String | Service type. Valid value: redis (TencentDB for Redis). |
Parameter Name | Type | Description |
---|---|---|
AsyncRequestId | Integer | Async task ID that is returned after the session killing task is created. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProxySessionKillTask
<Common request parameters>
{
"InstanceId": "cdb-8jawylhf",
"Product": "redis"
}
{
"Response": {
"AsyncRequestId": 123456,
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Operation failed. |
OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
Was this page helpful?