tencent cloud

Feedback

ModifyDReadable

Last updated: 2024-11-26 16:33:17

1. API Description

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

This API is used to enable or disable the read-only feature of the replica server.

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: ModifyDReadable.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
Type Yes String Operation type. Valid values: enable - enabling the read-only mode of the replica server; disable - disabling the read-only mode of the replica server
VpcId No String Replica server network ID, which will be consistent with the primary instance by default if left blank
SubnetId No String Replica server subnet ID, which will be consistent with the primary instance by default if left blank
Vip No String Specified replica server read-only VIP, which will be assigned automatically if left blank

3. Output Parameters

Parameter Name Type Description
FlowId 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 Enabling or Disabling the Read-Only Feature of the Replica Server

This example shows you how to enable or disable the read-only feature of the replica server by this API.

Input Example

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

{
    "InstanceId": "mssql-j8kv137v",
    "Type": "enable",
    "VpcId": "vpc-jh8ah7",
    "SubnetId": "sub-i90aoa",
    "Vip": "127.0.0.1"
}

Output Example

{
    "Response": {
        "RequestId": "1fed8472-f117-11ec-be47-525400853186",
        "FlowId": 1012152
    }
}

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.DBError Database error.
FailedOperation.GcsError The operation failed or the network timed out.
FailedOperation.NotSupport The operation is not supported.
ResourceNotFound.ParamsNotFound Parameter not found.
ResourceNotFound.VpcNotExist The VPC does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
ResourceUnavailable.VpcNotExist VPC not found.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support