CreateNetworkDomain - 创建网络域

如果您想统一运维分布在不同网络环境中或与堡垒机所在专有网络(VPC)网络不互通的资产,推荐使用堡垒机的网络域功能。您可以为这些资产配置一台代理服务器,然后在堡垒机中创建网络域并添加代理服务器,将资产加入该网络域后即可通过堡垒机运维资产。

调试

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

授权信息

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

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

请求参数

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

指定要创建网络域的堡垒机的实例 ID。

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

指定要创建网络域的堡垒机的地域 ID。

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

指定要创建的网络域名称,最大 128 字符。

SSH代理
NetworkDomainTypestring

指定要创建的网络域类型。取值:

  • Direct:直连,表示堡垒机直接和资产网络连通,不经过中间代理服务器。
  • Proxy:代理,资产所在网络与堡垒机网络不通的情况下,可以通过代理服务器转发网络请求,实现对不同网络环境下的资产进行运维。
Proxy
Commentstring

网络域的备注。最多 500 字符。

comment
Proxiesarray<object>

代理服务器信息。

object
ProxyTypestring

代理方式。取值:

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

代理服务器节点。取值:

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

代理服务器地址。

47.104.**.**
Portinteger

代理服务器端口。

22
Userstring

代理服务器主机账户。

root
Passwordstring

Base64 处理后的代理服务器账户的密码。

UWdi******Ng==

返回参数

名称类型描述示例值
object
NetworkDomainIdstring

网络域 ID。

31
RequestIdstring

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

A2873E9C-A7EA-5735-845C-65D3792623D2

示例

正常返回示例

JSON格式

{
  "NetworkDomainId": "31",
  "RequestId": "A2873E9C-A7EA-5735-845C-65D3792623D2"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
400NetworkDomainAlreadyExistsThe network domain already exists.网络域已存在
500InternalErrorAn unknown error occurred.未知错误

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