Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to enable dedicated access groups for read-only instances.
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: 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 Cluster information description to get the clusterId. |
| InstanceId | Yes | String | Please use Cluster information description to get the instanceId. |
| VpcId | Yes | String | Designated vpc ID. Please use query the vpc list to get the vpc ID. |
| SubnetId | Yes | String | Designated subnet ID. If vpc ID is set up, 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. Please use View Security Group to get the SecurityGroupId. |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | SDK 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. |
Any scenario
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"
]
}{
"Response": {
"FlowId": 12345,
"RequestId": "123123123123123"
}
}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.DatabaseAccessError | Database access failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.FlowCreateError | Failed to create the process. Please retry later. If the issue continues, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| InternalError.SystemError | Internal system error. |
| InvalidParameterValue.ParamError | Parameter error. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
フィードバック