CreateNetworkDomain - Bastionhost - Alibaba Cloud Documentation Center

If you want to perform O\\\\\\&M operations on assets that reside in different networks or assets that cannot communicate with the virtual private cloud (VPC) of your bastion host in a centralized manner, we recommend that you use the network domain feature of Bastionhost. You can configure a proxy server for these assets, create a network domain for a bastion host, and then connect the network domain to the proxy server. This way, you can perform O\\\\\\&M operations on the assets by using the bastion host.

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

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host for which you want to create a network domain. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-lbj3bw4ma02
RegionId	string	No	The region ID of the bastion host for which you want to create a network domain. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
NetworkDomainName	string	Yes	The name of the network domain that you want to create. The name can be up to 128 characters in length.	SSH Proxy
NetworkDomainType	string	Yes	The connection mode of the network domain to be created. Valid values: Direct Proxy	Proxy
Comment	string	No	The remarks of the network domain. The remarks can be up to 500 characters in length.	comment
Proxies	array<object>	No	The information about the proxy servers.
	object	No
User	string	No	The username of the proxy server.	root
Address	string	No	The IP address of the proxy server.	47.104..
ProxyType	string	No	The proxy type. Valid values: SSHProxy HTTPProxy Socks5Proxy	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.	UWdi******Ng==
Port	integer	No	The port of the proxy server.	22

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.