All Products
Search
Document Center

Bastionhost:CreateDatabase

Last Updated:Nov 27, 2024

Imports an ApsaraDB RDS for MySQL instance, ApsaraDB RDS for SQL Server instance, ApsaraDB RDS for PostgreSQL instance, PolarDB for MySQL cluster, PolarDB for PostgreSQL cluster, PolarDB for PostgreSQL (Compatible with Oracle) cluster, self-managed MySQL database, self-managed SQL Server database, self-managed PostgreSQL database, or self-managed Oracle database to a bastion host.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:CreateDatabase
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The bastion host ID.

Note You can call the DescribeInstances operation to query the bastion host ID.
bastionhost-cn-7mz2g5hu20e
RegionIdstringNo

The region ID of the bastion host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-shanghai
NetworkDomainIdstringNo

The ID of the network domain to which the database to add belongs.

Note You can call the ListNetworkDomains operation to query the network domain ID.
1
DatabaseTypestringYes

The type of the database engine. Valid values:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
ActiveAddressTypestringYes

The address type of the database to add. Valid values:

  • Public
  • Private
Public
DatabasePrivateAddressstringNo

The internal IP address of the database. Specify an IPv4 address or a domain name.

Note This parameter is required if ActiveAddressType is set to Private.
pgm-uf6o******
DatabasePublicAddressstringNo

The public IP address of the database. Specify an IPv4 address or a domain name.

Note This parameter is required if ActiveAddressType is set to Public.
rm-uf65251k51******
DatabasePortintegerNo

The port of the database. This parameter is required if Source is set to Local.

5433
DatabaseNamestringNo

The name of the database to add. This parameter is required if Source is set to Local.

Oracle
SourceInstanceIdstringNo

The instance ID of the database to add.

Note This parameter is required if Source is set to Rds or PolarDB.
i-bp19ienyt0yax748****
SourcestringYes

The type of the database to add. Valid values:

  • Local: on-premises database.
  • Rds: ApsaraDB RDS instance.
  • PolarDB: PolarDB cluster.
Local
CommentstringNo

The remarks of the database to add. The remarks can be up to 500 characters in length.

cpp
SourceInstanceRegionIdstringNo

The region ID of the database to add.

Note This parameter is required if Source is set to Rds or PolarDB.
cn-shanghai
PolarDBEndpointTypestringNo

The endpoint type of the PolarDB database. This parameter is required if Source is set to PolarDB. Valid values:

  • Cluster
  • Primary
Cluster

Response parameters

ParameterTypeDescriptionExample
object
DatabaseIdstring

The database ID.

334
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
400LicenseOutOfLimitThe maximum number of hosts exceeds the license limit.The maximum number of hosts exceeds the license limit.
400DatabaseAlreadyExistsThe database already exists.The database already exists.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.