全部产品
Search
文档中心

运维安全中心(堡垒机):CreateDatabase - 在堡垒机中创建需要运维的数据库

更新时间:Nov 27, 2024

您可以通过本接口,将MySQL、SQL Server、PostgreSQL类型的RDS和MySQL、PostgreSQL、PostgreSQL(兼容Oracle)的PolarDB以及MySQL、SQL Server、PostgreSQL、Oracle类型的自建数据库资产导入至堡垒机。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:CreateDatabase
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

堡垒机实例的 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-7mz2g5hu20e
RegionIdstring

堡垒机的地域 ID。

说明 地域 ID 和地域名称的对应关系,请参见地域和可用区
cn-shanghai
NetworkDomainIdstring

指定新创建数据库所属的网络域 ID。

说明 您可以调用ListNetworkDomains 接口获取该参数。
1
DatabaseTypestring

数据库类型,取值如下:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
ActiveAddressTypestring

指定新创建数据库的地址类型。取值:

  • Public:公网地址
  • Private:私网地址
Public
DatabasePrivateAddressstring

私网地址。支持 IPv4 地址和域名格式。

说明 ActiveAddressType 选择 Private 时,该参数为必填项。
192.168.XX.XX
DatabasePublicAddressstring

公网地址。支持 IPv4 地址和域名格式。

说明 ActiveAddressType 选择 Public 时,该参数为必填项。
www.example.com
DatabasePortinteger

数据库的访问端口。数据库来源为 Local,该参数为必填项。

5433
DatabaseNamestring

新创建的数据库实例名称。数据库来源为 Local,该参数为必填项。

Test01
SourceInstanceIdstring

指定新创建的数据库实例 ID。

说明 Source 选择 RdsPolarDB 时,该参数为必填项。
i-bp19ienyt0yax748****
Sourcestring

指定新创建数据库的来源。取值:

  • Local:本地数据库实例
  • Rds:RDS 类型数据库实例
  • PolarDB: PolarDB 类型数据库实例
Local
Commentstring

指定新创建的数据库的备注信息。最多支持 500 字符。

cpp
SourceInstanceRegionIdstring

指定新创建的数据库实例所属地域 ID。

说明 SourceRdsPolarDB 时,该参数为必填项。
cn-shanghai
PolarDBEndpointTypestring

Source 为 PolarDB 时必传,表示 PolarDB 的 Endpoint 类型,取值:

  • Cluster:集群地址
  • Primary:主地址
Cluster

返回参数

名称类型描述示例值
object
DatabaseIdstring

数据库实例 ID。

334
RequestIdstring

阿里云为该请求生成的唯一标识符。

98EDD923-236C-5A88-88E7-4979A91B9325

示例

正常返回示例

JSON格式

{
  "DatabaseId": "334",
  "RequestId": "98EDD923-236C-5A88-88E7-4979A91B9325"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
400LicenseOutOfLimitThe maximum number of hosts exceeds the license limit.主机数超出许可限制
400DatabaseAlreadyExistsThe database already exists.数据库已存在
500InternalErrorAn unknown error occurred.未知错误

访问错误中心查看更多错误码。