ListNetworkDomains - 获取指定堡垒机下网络域列表

获取指定堡垒机下的网络域列表。

调试

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

授权信息

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

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

请求参数

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

堡垒机的实例 ID。

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

堡垒机的区域 ID。

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

指定分页查询时,当前页的页码。默认值为 1

1
PageSizestring

指定分页查询时,每页显示的数据最大条数。
PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
NetworkDomainNamestring

网络域名称。

SSH代理
NetworkDomainTypestring

网络域类型。取值:

  • Direct:直连
  • Proxy:代理
Proxy

返回参数

名称类型描述示例值
object
NetworkDomainsarray<object>

查询到的网络域列表。

itemobject
Commentstring

网络域的备注信息。

comment
Defaultboolean

是否为内置网络域。

  • true:是
  • false:否
true
NetworkDomainIdstring

网络域的 ID。

2
NetworkDomainNamestring

网络域名称。

test
NetworkDomainTypestring

网络域类型。取值:

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

代理服务器信息。

itemobject
NodeTypestring

代理服务器节点。取值:

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

代理服务器状态。

  • Available:可用
  • Unavailable:不可用
Available
RequestIdstring

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCountlong

查询到的网络域总数量。

5

示例

正常返回示例

JSON格式

{
  "NetworkDomains": [
    {
      "Comment": "comment",
      "Default": true,
      "NetworkDomainId": "2",
      "NetworkDomainName": "test",
      "NetworkDomainType": "Proxy",
      "ProxiesState": [
        {
          "NodeType": "Master",
          "ProxyState": "Available"
        }
      ]
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 5
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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