tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyConnectionConfig

Last updated: 2024-12-04 11:18:46

1. API Description

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

This API is used to modify the connection configuration of an instance, including the bandwidth and maximum number of connections.

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: ModifyConnectionConfig.
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.
Bandwidth No Integer Additional bandwidth in MB, which should be greater than 0.
ClientLimit No Integer Total number of connections per shard.
- When read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.
- When read-only replicas are enabled, the lower limit is 10,000, and the upper limit is calculated as follows: 10,000 x (Number of read-only replicas + 3).

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 Sample

Input Example

https://redis.intl.tencentcloudapi.com/?Action=ModifyConnectionConfig
&InstanceId=crs-cpz6b1fn
&Bandwidth=5
&ClientLimit=20000
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "950088b4-c71f-4bb3-ae6d-a0d0569f8666",
        "TaskId": 95027
    }
}

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy