Retrieve Network Domain Details with GetNetworkDomain API - Bastionhost - Alibaba Cloud - Bastionhost

Retrieves the details of a specified network domain.

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:GetNetworkDomain

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the bastion host. Note You can invoke the DescribeInstances operation to obtain this parameter.	bastionhost-cn-i7m2btk6g48
RegionId	string	No	The region ID of the bastion host. Note For 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 obtain this parameter.	3
CheckProxyState	string	No	Specifies whether to immediately re-check the proxy server status. Valid values: true: Immediately re-checks the proxy server status and returns the latest ProxyState/ProxyStateErrorCode. false: Default value. Does not re-check the proxy server status and directly returns the currently recorded status.	false
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
NetworkDomain	object	The details of 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: Yes. false: No.	false
NetworkDomainId	string	The network domain ID.	2
NetworkDomainName	string	The network domain name.	SSH Proxy
NetworkDomainType	string	The network domain type. Valid values: Direct: direct connection Proxy: proxy	Proxy
Proxies	array<object>	The proxy server information.
	object	The proxy server information.
ProxyType	string	The proxy method. Valid values: SSHProxy: SSH proxy HTTPProxy: HTTP proxy Socks5Proxy: SOCKS proxy	HTTPProxy
NodeType	string	The proxy server node. Valid values: Master: primary proxy server Slave: secondary proxy server	Master
Address	string	The proxy server address.	47.102..
Port	integer	The proxy server port.	22
User	string	The username of the proxy server.	root
HasPassword	boolean	Indicates whether a password is set for the proxy server. Valid values: true: A password is set. false: No password is set.	true
ProxyState	string	The proxy server status. Valid values: Available: The proxy server is available. Unavailable: The proxy server is unavailable.	Unavailable
ProxyStateErrorCode	string	The error code of the proxy server status. CHECK_PWD_FAILED: The password is incorrect. Password verification failed. CHECK_PWD_TIMEOUT: Password verification timed out. CHECK_PWD_NETWORK_ERR: A network error occurred. UNEXPECTED: An unknown error occurred.	CHECK_PWD_TIMEOUT
RequestId	string	The request ID generated by Alibaba Cloud for this request.	05F59944-2E24-595C-B21A-8C9955E60FAF

Examples

Success response

JSON format

{
  "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.
500	InternalError	An unknown error occurred.	An unknown error occurred.
404	NetworkDomainNotFound	The network domain is not found.	The network domain is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.