CloseDBExtranetAccess

Last updated: 2020-07-31 11:06:32

1. API Description

Domain name for API request: mariadb.tencentcloudapi.com.

This API is used to disable public network access for a TencentDB instance, which will make the public IP address inaccessible. The DescribeDCDBInstances API will not return the public domain name and port information of the corresponding instance.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mariadb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CloseDBExtranetAccess.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String ID of instance for which to disable public network access. The ID is in the format of tdsql-ow728lmc and can be obtained through the DescribeDBInstances API.
Ipv6Flag No Integer Whether IPv6 is used. Default value: 0

3. Output Parameters

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.

4. Example

Example1 Disabling public network access for TencentDB instance

Input Example

https://mariadb.tencentcloudapi.com/?Action=CloseDBExtranetAccess
&InstanceId=tdsql-avw0207d
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "2d1e21a2-b29a-490a-8be0-b61287d92e28",
    "FlowId": 3324
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.CreateFlowFailed Failed to create the flow.
InternalError.CamAuthFailed CAM authentication request 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 deleted.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help