Domain name for API request: dcdb.tencentcloudapi.com.
This API is used to enable public network access for a TencentDB instance. After that, you can access the instance with the public domain name and port obtained through the DescribeDCDBInstances API.
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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: OpenDBExtranetAccess. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-11. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ID of an instance for which to enable public network access. The ID is in the format of dcdbt-ow728lmc. |
| Ipv6Flag | No | Integer | Whether IPv6 is used. Default value: 0 |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Async task ID. The task status can be queried through the DescribeFlow API. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dcdb.tencentcloudapi.com/?Action=OpenDBExtranetAccess
&InstanceId=dcdbt-avw0207d
&<Common request parameters>
{
"Response": {
"RequestId": "901bd41c-08a2-4001-8364-5a63f32056ae",
"FlowId": 3023
}
}
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.CreateFlowFailed | Failed to create the flow. |
| InternalError.CamAuthFailed | CAM authentication request failed. |
| InternalError.OperateDatabaseFailed | Database operation failed. |
| InvalidParameter.GenericParameterError | An error occurred while verifying parameter validity. |
| ResourceNotFound.NoInstanceFound | The specified database instance was not found. |
| ResourceUnavailable.InstanceAlreadyDeleted | The database instance has been dropped. |
| ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
| UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
文档反馈