OpenReadOnlyInstanceExclusiveAccess

Last updated: 2025-11-13 20:51:09

OpenReadOnlyInstanceExclusiveAccess

Last updated: 2025-11-13 20:51:09

1. API Description

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

This interface (OpenReadOnlyInstanceExclusiveAccess) is used to enable the dedicated access access group for a read-only instance.

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: OpenReadOnlyInstanceExclusiveAccess.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Please use the cluster information description (https://www.tencentcloud.com/document/api/1003/48086?from_cn_redirect=1) to obtain the clusterId.
InstanceId	Yes	String	Please use the cluster information description (https://www.tencentcloud.com/document/api/1003/48086?from_cn_redirect=1) to obtain the instanceId.
VpcId	Yes	String	Specifies the designated vpc ID. please use the "query vpc list" to obtain the vpc ID.
SubnetId	Yes	String	Specified subnet ID. if vpc ID is set, SubnetId is required. please use query subnet list (https://www.tencentcloud.com/document/api/215/15784?from_cn_redirect=1) to get SubnetId.
Port	Yes	Integer	User-Defined port.
SecurityGroupIds.N	No	Array of String	Security group ID. use view security group to obtain the SecurityGroupId.

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Activation process 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 ex:

Any scenario

Input Example

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

{
    "ClusterId": "cynosdbmysql-qwertyui",
    "InstanceId": "cynosdbmysql-ins-asdfghjk",
    "VpcId": "vpc-asdfghjk",
    "SubnetId": "subnet-qwertyui",
    "Port": 3306,
    "SecurityGroupIds": [
        "SecurityGroupIds1",
        "SecurityGroupIds2"
    ]
}

Output Example

{
    "Response": {
        "FlowId": 12345,
        "RequestId": "123123123123123"
    }
}

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
FailedOperation.DatabaseAccessError	Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError	Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.SystemError	Internal system error.
InvalidParameterValue.ParamError	Incorrect parameter.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud