调用GetNetworkDomain获取指定网络域详情-运维安全中心（堡垒机）-阿里云-运维安全中心（堡垒机）(Bastionhost)-阿里云帮助中心

获取指定网络域详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	堡垒机的实例 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-i7m2btk6g48
RegionId	string	否	堡垒机的地域 ID。说明 Region ID 和地域名称的对应关系，请参见地域和可用区。	cn-hangzhou
NetworkDomainId	string	是	指定要查询的网络域 ID。说明您可以调用 ListNetworkDomains 接口获取该参数。	3
CheckProxyState	string	否	是否立即重新检测代理服务器状态。取值： true：立即重新检测代理服务器状态并返回最新的 ProxyState/ProxyStateErrorCode。 false：默认取值。不重新检测代理服务器状态，直接返回当前记录的状态。	false

返回参数

名称	类型	描述	示例值
	object
NetworkDomain	object	网络域的详细信息。
Comment	string	网络域的备注。	comment
Default	boolean	是否为内置网络域。 true：是 false：否	false
NetworkDomainId	string	网络域 ID。	2
NetworkDomainName	string	网络域名称。	SSH Proxy
NetworkDomainType	string	网络域类型。取值： Direct：直连 Proxy：代理	Proxy
Proxies	array<object>	代理服务器信息。
	object	代理服务器信息。
ProxyType	string	代理方式。取值： SSHProxy：SSH 代理 HTTPProxy：HTTP 代理 Socks5Proxy：Socks 代理	HTTPProxy
NodeType	string	代理服务器节点。取值： Master：主代理服务器 Slave：备代理服务器	Master
Address	string	代理服务器地址。	47.102..
Port	integer	代理服务器端口。	22
User	string	代理服务器账户名。	root
HasPassword	boolean	代理服务器是否设置密码。取值： true：设置密码 false：未设置密码	true
ProxyState	string	代理服务器状态。 Available：可用 Unavailable：不可用	Unavailable
ProxyStateErrorCode	string	代理服务器状态错误码。 CHECK_PWD_FAILED：密码错误，验密失败 CHECK_PWD_TIMEOUT：验密超时 CHECK_PWD_NETWORK_ERR：网络错误 UNEXPECTED：未知错误	CHECK_PWD_TIMEOUT
RequestId	string	阿里云为该请求生成的唯一标识符。	05F59944-2E24-595C-B21A-8C9955E60FAF

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
500	InternalError	An unknown error occurred.	未知错误
404	NetworkDomainNotFound	The network domain is not found.	网络域不存在

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。