tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyRoGroupInfo

Last updated: 2024-11-20 11:14:57

    1. API Description

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

    This API is used to update the information of a TencentDB RO group, such as configuring a read-only instance removal policy in case of excessive delay, setting read weights of read-only instances, and setting the replication delay.

    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: ModifyRoGroupInfo.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    RoGroupId Yes String RO group ID.
    RoGroupInfo No RoGroupAttr RO group details.
    RoWeightValues.N No Array of RoWeightValue Weights of instances in RO group. If the weighting mode of an RO group is changed to custom mode, this parameter must be set, and a weight value needs to be set for each RO instance.
    IsBalanceRoLoad No Integer Whether to rebalance the loads of read-only replicas in the RO group. Valid values: 1 (yes), 0 (no). Default value: 0. If this parameter is set to 1, connections to the read-only replicas in the RO group will be interrupted transiently. Please ensure that your application has a reconnection mechanism.
    ReplicationDelayTime No Integer This field has been deprecated.

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestId String Async task ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Configuring the removal policy for delayed instances in an RO group

    Input Example

    POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoGroupInfo
<Common request parameters>

{
    "RoGroupId": "cdbrg-iup41a4t",
    "RoGroupInfo": {
        "RoOfflineDelay": "1",
        "MinRoInGroup": "1",
        "RoMaxDelayTime": "10"
    }
}

    Output Example

    {
    "Response": {
        "RequestId": "xx",
        "AsyncRequestId": "xx"
    }
}

    Example2 Rebalancing the weights of instances in an RO group

    Input Example

    POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoGroupInfo
<Common request parameters>

{
    "RoWeightValues": [
        {
            "InstanceId": "cdbr0-test1234",
            "Weight": "70"
        },
        {
            "InstanceId": "cdbr0-iup41a4t",
            "Weight": "30"
        }
    ],
    "IsBalanceRoLoad": "1",
    "RoGroupId": "cdbrg-iup41a4t",
    "RoGroupInfo": {
        "WeightMode": "custom"
    }
}

    Output Example

    {
    "Response": {
        "RequestId": "xx",
        "AsyncRequestId": "xx"
    }
}

    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.DescribeProxyGroupError Failed to query database proxy.
    FailedOperation.StatusConflict Task status conflict.
    InternalError.DBRecordNotExistError The database record does not exist.
    InternalError.DatabaseAccessError Internal database error.
    InternalError.TaskFrameError Async task error.
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    InvalidParameterValue.DataConvertError Data conversion failed.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    MissingParameter.MissingParamError Required parameters are missing.
    OperationDenied.ConflictRoStatus The operation is not allowed as the RO group contains an invalid read-only instance.
    OperationDenied.ConflictStatus The configuration of read-only group is being modified. Please do not make repeated requests.
    OperationDenied.DelayReplicationRunning The operation is not allowed during the delayed replication.
    OperationDenied.InstanceLockerConflict Instance locks are in conflict. Please try again later.
    ResourceNotFound.CdbInstanceNotFoundError The instance cannot be found. Please check whether your instance status is normal.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy