Bastionhost allows you to perform O\\\&M operations on hosts from different sources, such as Alibaba Cloud Elastic Compute Service (ECS) instances, servers in on-premises data centers, and servers on other cloud platforms. Before you perform O\\\&M operations on hosts by using a bastion host, you must import the hosts to the bastion host. You can call this operation to import a host 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:CreateHost | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the bastion host in which you want to create the host. Note
You can call the DescribeInstances operation to query the ID of the bastion host.
| bastionhost-cn-st220aw**** |
| RegionId | string | No | The region ID of the bastion host to which you want to import the host. Note
For information about the mapping between region IDs and region names, see Regions and zones.
| cn-hangzhou |
| HostPrivateAddress | string | No | The internal endpoint of the host that you want to create. You can set this parameter to a domain name or an IP address. Note
This parameter is required if the ActiveAddressType parameter is set to Private.
| 192.168.XX.XX |
| HostPublicAddress | string | No | The public endpoint of the host that you want to create. You can set this parameter to a domain name or an IP address. Note
This parameter is required if the ActiveAddressType parameter is set to Public.
| 172.16.XX.XX |
| ActiveAddressType | string | Yes | The endpoint type of the host that you want to create. Valid values:
| Public |
| HostName | string | Yes | The name of the host that you want to create. The name can be up to 128 characters in length. | host01 |
| Source | string | Yes | The source of the host that you want to create. Valid values:
| Local |
| OSType | string | Yes | The operating system of the host that you want to create. Valid values:
| Linux |
| Comment | string | No | The description of the host that you want to create. The value can be up to 500 characters in length. | Local Host |
| SourceInstanceId | string | No | The ID of the ECS instance or the host in an ApsaraDB MyBase dedicated cluster. Note
This parameter is required if the Source parameter is set to Ecs or Rds.
| i-dfabfda |
| InstanceRegionId | string | No | The ID of the region to which the ECS instance or the host in an ApsaraDB MyBase dedicated cluster belongs. Note
This parameter is required if the Source parameter is set to Ecs or Rds.
| cn-hangzhou |
| NetworkDomainId | string | No | The ID of the network domain to which the host to be imported belongs. Note
You can call the ListNetworkDomains operation to query the network domain ID.
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"HostId": "1",
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
| 400 | LicenseOutOfLimit | The host count is out of limit. | - |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-11-27 | The Error code has changed. The request parameters of the API has changed | View Change Details |