All Products
Search

This Product

    Bastionhost:CreateHost

    Document Center

    Bastionhost:CreateHost

    Last Updated:Dec 08, 2025

    Bastionhost lets you manage hosts from various sources, such as Alibaba Cloud ECS servers, on-premises servers, and servers from other cloud providers. Before you can manage a host, you must import it into Bastionhost. You can call this operation to create hosts in Bastionhost.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-bastionhost:CreateHost

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance where you want to create the host.

    Note

    Call the DescribeInstances operation to obtain this parameter.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the Bastionhost instance where you want to create the host.

    Note

    For more information about the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou
    HostPrivateAddress

    string

    No

    The private address of the host. You can use a domain name or an IP address.

    Note

    This parameter is required when ActiveAddressType is set to Private.

    192.168.XX.XX
    HostPublicAddress

    string

    No

    The public address of the host. You can use a domain name or an IP address.

    Note

    This parameter is required when ActiveAddressType is set to Public.

    172.16.XX.XX
    ActiveAddressType

    string

    Yes

    The address type of the host. Valid values:

    • Public: a public address

    • Private: a private address

    Public
    HostName

    string

    Yes

    The name of the host. The name can be up to 128 characters in length.

    host01
    Source

    string

    Yes

    The source of the host. Valid values:

    • Local: a local host

    • Ecs: an ECS instance

    • Rds: a host in an ApsaraDB RDS dedicated cluster

    Local
    OSType

    string

    Yes

    The operating system of the host. Valid values:

    • Linux

    • Windows

    Linux
    Comment

    string

    No

    The comment for the host. The comment can be up to 500 characters in length.

    Local Host
    SourceInstanceId

    string

    No

    The ID of the ECS instance or the host in the dedicated cluster.

    Note

    This parameter is required when Source is set to Ecs or Rds.

    i-dfabfda
    InstanceRegionId

    string

    No

    The region ID of the ECS instance or the host in the dedicated cluster.

    Note

    This parameter is required when Source is set to Ecs or Rds.

    cn-hangzhou
    NetworkDomainId

    string

    No

    The ID of the network domain to which the host belongs.

    Note

    Call the ListNetworkDomains operation to obtain this parameter.

    1
    InstanceMemberId

    integer

    No

    The ID of the Alibaba Cloud account to which the ECS instance belongs.

    1605494xxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    HostId

    string

    The ID of the new host.

    1
    RequestId

    string

    The ID of the request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    Examples

    Success response

    JSON format

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.