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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-bastionhost:CreateDatabase |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The bastion host ID. Note
You can call the DescribeInstances operation to query the bastion host ID.
| bastionhost-cn-7mz2g5hu20e |
| RegionId | string | No | 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 |
| NetworkDomainId | string | No | 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 |
| DatabaseType | string | Yes | The type of the database engine. Valid values:
| MySQL |
| ActiveAddressType | string | Yes | The address type of the database to add. Valid values:
| Public |
| DatabasePrivateAddress | string | No | 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****** |
| DatabasePublicAddress | string | No | 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****** |
| DatabasePort | integer | No | The port of the database. This parameter is required if Source is set to Local. | 5433 |
| DatabaseName | string | No | The name of the database to add. This parameter is required if Source is set to Local. | Oracle |
| SourceInstanceId | string | No | The instance ID of the database to add. Note
This parameter is required if Source is set to Rds or PolarDB.
| i-bp19ienyt0yax748**** |
| Source | string | Yes | The type of the database to add. Valid values:
| Local |
| Comment | string | No | The remarks of the database to add. The remarks can be up to 500 characters in length. | cpp |
| SourceInstanceRegionId | string | No | The region ID of the database to add. Note
This parameter is required if Source is set to Rds or PolarDB.
| cn-shanghai |
| PolarDBEndpointType | string | No | The endpoint type of the PolarDB database. This parameter is required if Source is set to PolarDB. Valid values:
| Cluster |
Response parameters
Examples
Sample success responses
JSONformat
{
"DatabaseId": "334",
"RequestId": "98EDD923-236C-5A88-88E7-4979A91B9325"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
| 400 | LicenseOutOfLimit | The maximum number of hosts exceeds the license limit. | The maximum number of hosts exceeds the license limit. |
| 400 | DatabaseAlreadyExists | The database already exists. | The database already exists. |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.