GetNetworkDomain - 获取指定网络域详情 - 运维安全中心（堡垒机）

获取指定网络域详情。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-bastionhost:GetNetworkDomain		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	堡垒机的实例 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-i7m2btk6g48
RegionId	string	否	堡垒机的地域 ID。说明 Region ID 和地域名称的对应关系，请参见地域和可用区。	cn-hangzhou
NetworkDomainId	string	是	指定要查询的网络域 ID。说明您可以调用 ListNetworkDomains 接口获取该参数。	3

返回参数

名称	类型	描述	示例值
	object
NetworkDomain	object	网络域的详细信息。
Comment	string	网络域的备注。	comment
Default	boolean	是否为内置网络域。 true：是 false：否	false
NetworkDomainId	string	网络域 ID。	2
NetworkDomainName	string	网络域名称。	SSH代理
NetworkDomainType	string	网络域类型。取值： Direct：直连 Proxy：代理	Proxy
Proxies	array<object>	代理服务器信息。
item	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代理",
    "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.	参数错误
404	NetworkDomainNotFound	The network domain is not found.	网络域不存在
500	InternalError	An unknown error occurred.	未知错误

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