GetNetworkDomain - 获取指定网络域详情

获取指定网络域详情。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-i7m2btk6g48
RegionIdstring

堡垒机的地域 ID。

说明 Region ID 和地域名称的对应关系,请参见地域和可用区
cn-hangzhou
NetworkDomainIdstring

指定要查询的网络域 ID。

说明 您可以调用 ListNetworkDomains 接口获取该参数。
3

返回参数

名称类型描述示例值
object
NetworkDomainobject

网络域的详细信息。

Commentstring

网络域的备注。

comment
Defaultboolean

是否为内置网络域。

  • true:是
  • false:否
false
NetworkDomainIdstring

网络域 ID。

2
NetworkDomainNamestring

网络域名称。

SSH代理
NetworkDomainTypestring

网络域类型。取值:

  • Direct:直连
  • Proxy:代理
Proxy
Proxiesarray<object>

代理服务器信息。

itemobject

代理服务器信息。

ProxyTypestring

代理方式。取值:

  • SSHProxy:SSH 代理
  • HTTPProxy:HTTP 代理
  • Socks5Proxy:Socks 代理
HTTPProxy
NodeTypestring

代理服务器节点。取值:

  • Master:主代理服务器
  • Slave:备代理服务器
Master
Addressstring

代理服务器地址。

47.102.**.**
Portinteger

代理服务器端口。

22
Userstring

代理服务器账户名。

root
HasPasswordboolean

代理服务器是否设置密码。取值:

  • true:设置密码
  • false:未设置密码
true
ProxyStatestring

代理服务器状态。

  • Available:可用
  • Unavailable:不可用
Unavailable
ProxyStateErrorCodestring

代理服务器状态错误码。

  • CHECK_PWD_FAILED:密码错误,验密失败
  • CHECK_PWD_TIMEOUT:验密超时
  • CHECK_PWD_NETWORK_ERR:网络错误
  • UNEXPECTED:未知错误
CHECK_PWD_TIMEOUT
RequestIdstring

阿里云为该请求生成的唯一标识符。

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错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
404NetworkDomainNotFoundThe network domain is not found.网络域不存在
500InternalErrorAn unknown error occurred.未知错误

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