GetNetworkDomain - Bastionhost - Alibaba Cloud Documentation Center

Queries the detailed information about 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GetNetworkDomain		All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The bastion host ID. Note You can call the DescribeInstances operation to query the bastion host ID.	bastionhost-cn-i7m2btk6g48
RegionId	string	No	The region ID of the bastion host. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
NetworkDomainId	string	Yes	The ID of the network domain to query. Note You can call the ListNetworkDomains operation to query the network domain ID.	3

Response parameters

Parameter	Type	Description	Example
	object
NetworkDomain	object	The detailed information about the network domain.
Comment	string	The remarks of the network domain.	comment
Default	boolean	Indicates whether the network domain is a built-in network domain. true false	false
NetworkDomainId	string	The network domain ID.	2
NetworkDomainName	string	The name of the network domain.	SSH Proxy
NetworkDomainType	string	The connection mode of the network domain. Valid values: Direct Proxy	Proxy
Proxies	array<object>	The information about the proxy servers.
item	object
ProxyType	string	The proxy type. Valid values: SSHProxy HTTPProxy Socks5Proxy	HTTPProxy
NodeType	string	The node type of the proxy server. Valid values: Master: primary proxy server. Slave: secondary proxy server.	Master
Address	string	The IP address of the proxy server.	47.102..
Port	integer	The port of the proxy server.	22
User	string	The username of the proxy server.	root
HasPassword	boolean	Indicates whether the proxy server has a password. Valid values: true false	true
ProxyState	string	The status of the proxy server. Available Unavailable	Unavailable
ProxyStateErrorCode	string	The error code that indicates the status of the proxy server. CHECK_PWD_FAILED: The password is invalid. CHECK_PWD_TIMEOUT: The password verification session timed out. CHECK_PWD_NETWORK_ERR: A network error occurred. UNEXPECTED: An unknown error occurred.	CHECK_PWD_TIMEOUT
RequestId	string	The request ID.	05F59944-2E24-595C-B21A-8C9955E60FAF

Examples

Sample success responses

JSONformat

{
  "NetworkDomain": {
    "Comment": "comment",
    "Default": false,
    "NetworkDomainId": "2",
    "NetworkDomainName": "SSH Proxy",
    "NetworkDomainType": "Proxy",
    "Proxies": [
      {
        "ProxyType": "HTTPProxy",
        "NodeType": "Master",
        "Address": "47.102.**.**",
        "Port": 22,
        "User": "root",
        "HasPassword": true,
        "ProxyState": "Unavailable",
        "ProxyStateErrorCode": "CHECK_PWD_TIMEOUT"
      }
    ]
  },
  "RequestId": "05F59944-2E24-595C-B21A-8C9955E60FAF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
404	NetworkDomainNotFound	The network domain is not found.	The network domain is not found.
500	InternalError	An unknown error occurred.	An unknown error occurred.

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