All Products
Search

This Product

    Bastionhost:CreateNetworkDomain

    Document Center

    Bastionhost:CreateNetworkDomain

    Last Updated:Aug 11, 2026

    If you want to perform unified O&M on assets that are distributed across different network environments or that are not connected to the virtual private cloud (VPC) where Bastionhost resides, use the network domain feature of Bastionhost. You can configure a proxy server for these assets, create a network domain in Bastionhost and add the proxy server, and then add the assets to the network domain to manage them through 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:CreateNetworkDomain

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID of the Bastionhost instance for which you want to create a network domain.

    Note

    You can invoke the DescribeInstances operation to query this parameter.

    bastionhost-cn-lbj3bw4ma02
    RegionId

    string

    No

    The region ID of the Bastionhost instance for which you want to create a network domain.

    Note

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

    cn-hangzhou
    NetworkDomainName

    string

    Yes

    The name of the network domain to create. The name can be up to 128 characters in length.

    SSH Proxy
    NetworkDomainType

    string

    Yes

    The type of the network domain to create. Valid values:

    • Direct: direct connection. Bastionhost is directly connected to the asset network without an intermediate proxy server.

    • Proxy: proxy connection. If the network where the assets reside is not connected to the Bastionhost network, you can use a proxy server to forward network requests and manage assets in different network environments.

    Proxy
    Comment

    string

    No

    The description of the network domain. The description can be up to 500 characters in length.

    comment
    Proxies

    array<object>

    No

    The proxy server information.

    object

    No

    User

    string

    No

    The account of the proxy server.

    root
    Address

    string

    No

    The address of the proxy server.

    47.104.**.**
    ProxyType

    string

    No

    The proxy type. Valid values:

    • SSHProxy: SSH proxy.

    • HTTPProxy: HTTP proxy.

    • Socks5Proxy: SOCKS proxy.

    SSHProxy
    NodeType

    string

    No

    The node type of the proxy server. Valid values:

    • Master: primary proxy server.

    • Slave: secondary proxy server.

    Master
    Password

    string

    No

    The Base64-encoded password of the proxy server account.

    UWdi******Ng==
    Port

    integer

    No

    The Server Port of the proxy server.

    22

    No

    The project ID.

    Response elements

    Element

    Type

    Description

    Example

    object

    NetworkDomainId

    string

    The ID of the network domain.

    31
    RequestId

    string

    The request ID.

    A2873E9C-A7EA-5735-845C-65D3792623D2

    Examples

    Success response

    JSON format

    {
  "NetworkDomainId": "31",
  "RequestId": "A2873E9C-A7EA-5735-845C-65D3792623D2"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The argument is invalid. The argument is invalid.
    400 NetworkDomainAlreadyExists The network domain already exists. The network domain already exists.
    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.