tencent cloud

TDSQL for MySQL

Announcements
Alarm Upgrade
Product Introduction
Overview
Strengths
Use Cases
Regions and AZs
InnoDB engine
Purchase Guide
Billing Overview (InnoDB)
Product Pricing (InnoDB)
Purchase and Upgrade
Refund
Payment Overdue
Backup Space Billing
Getting Started
InnoDB Engine
Operation Guide(InnoDB)
Instance Management
Disaster Recovery Read-Only Instance
Changing Networks
Account Management
Security Management
Slow Query Analysis
Backup and Rollback
Data Migration
Database Audit
Practical Tutorial
Import from Standalone Instance to TDSQL Instance
Import Between TDSQL Instances
Selection of TDSQL Instance and Shard Configuration
Security White Paper
Platform Security Design
Tenant Security Features
Development Guide
InnoDB
API Documentation
History
Introduction
API Category
Security Group APIs
Other APIs
Making API Requests
TDSQL APIs
Data Types
Error Codes
FAQs
InnoDB
General References
Performance Comparison Data for Strong Sync
Glossary
Contact Us

CloseDBExtranetAccess

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-24 14:51:20

1. API Description

Domain name for API request: dcdb.intl.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.

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: CloseDBExtranetAccess.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String ID of an instance for which to disable public network access. The ID is in the format of dcdbt-ow728lmc and can be obtained through the DescribeDCDBInstances 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, 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 Disabling public network access for a TencentDB instance

Input Example

https://dcdb.intl.tencentcloudapi.com/?Action=CloseDBExtranetAccess
&InstanceId=dcdbt-avw0207d
&<Common request parameters>

Output Example

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

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.CreateFlowFailed Failed to create the flow.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.OperateDatabaseFailed Database operation failed.
InternalError.WanServiceFailed Public network 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.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック