tencent cloud

TDSQL MySQL 版

公告
告警升级公告
产品简介
产品概述
产品优势
应用场景
地域和可用区
InnoDB 引擎
购买指南
计费概述(InnoDB)
产品定价(InnoDB)
购买升级
退费说明
欠费说明
备份空间计费
快速入门
InnoDB 引擎
操作指南(InnoDB)
实例管理
灾备/只读实例
修改网络
账号管理
安全管理
慢查询分析
备份与回档
数据迁移
数据库审计
实践教程
从单机实例导入到分布式实例
从分布式实例导入到分布式实例
选择实例配置和分片配置
安全白皮书
平台侧安全设计
租户侧安全功能
开发指南
InnoDB 引擎
API 文档
History
Introduction
API Category
Security Group APIs
Other APIs
Making API Requests
TDSQL APIs
Data Types
Error Codes
常见问题
InnoDB 引擎相关
通用参考
强同步性能对比数据
词汇表
联系我们

OpenDBExtranetAccess

PDF
聚焦模式
字号
最后更新时间: 2022-01-20 14:40:15

1. API Description

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.

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.
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

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 Enabling public network access for a TencentDB instance

Input Example

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

Output Example

{
  "Response": {
    "RequestId": "901bd41c-08a2-4001-8364-5a63f32056ae",
    "FlowId": 3023
  }
}

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.
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.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈