All Products
Search
Document Center

Bastionhost:CreateNetworkDomain

Last Updated:Nov 27, 2024

Creates a network domain.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:CreateNetworkDomain
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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
RegionIdstringNo

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
NetworkDomainNamestringYes

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

NetworkDomainTypestringYes

The connection mode of the network domain to be created. Valid values:

  • Direct
  • Proxy
Proxy
CommentstringNo

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

comment
Proxiesarray<object>No

The information about the proxy servers.

objectNo
ProxyTypestringNo

The proxy type. Valid values:

  • SSHProxy
  • HTTPProxy
  • Socks5Proxy
SSHProxy
NodeTypestringNo

The node type of the proxy server. Valid values:

  • Master: primary proxy server.
  • Slave: secondary proxy server.
Master
AddressstringNo

The IP address of the proxy server.

47.104.**.**
PortintegerNo

The port of the proxy server.

22
UserstringNo

The username of the proxy server.

root
PasswordstringNo

The Base64-encoded password of the proxy server.

***

Response parameters

ParameterTypeDescriptionExample
object
NetworkDomainIdstring

The ID of the network domain.

31
RequestIdstring

The request ID.

A2873E9C-A7EA-5735-845C-65D3792623D2

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
400NetworkDomainAlreadyExistsThe network domain already exists.The network domain already exists.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.