文档

CreateHost - 在堡垒机中创建需要运维的主机

在堡垒机中创建需要运维的主机。

调试

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

授权信息

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

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

请求参数

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

指定新创建主机所在堡垒机的实例 ID。

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

指定新创建主机所在堡垒机的区域 ID。

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

指定新创建主机的私网地址,可使用域名或 IP 地址。

说明 ActiveAddressType 选择 Private 时,该参数为必填项。
192.168.XX.XX
HostPublicAddressstring

指定新创建主机的公网地址,可使用域名或 IP 地址。

说明 ActiveAddressType 选择 Public 时,该参数为必填项。
172.16.XX.XX
ActiveAddressTypestring

指定新创建主机的地址类型。取值:

  • Public:公网地址
  • Private:私网地址
Public
HostNamestring

指定新创建主机的名称,最多支持 128 字符。

host01
Sourcestring

指定新创建主机的来源。取值:

  • Local:本地主机
  • Ecs:ECS 实例
  • Rds:RDS 专属集群主机
Local
OSTypestring

指定新创建主机的操作系统。取值:

  • Linux
  • Windows
Linux
Commentstring

指定主机的备注信息,最多支持 500 字符。

Local Host
SourceInstanceIdstring

指定新创建的 ECS 实例 ID 或专属集群主机 ID。

说明 Source 选择 EcsRds 时,该参数为必填项。
i-dfabfda
InstanceRegionIdstring

指定新创建的 ECS 实例或专属集群主机所属区域 ID。

说明 Source 选择 EcsRds 时,该参数为必填项。
cn-hangzhou
NetworkDomainIdstring

指定新创建主机所属的网络域 ID。

1

返回参数

名称类型描述示例值
object
HostIdstring

新创建主机的 ID。

1
RequestIdstring

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

示例

正常返回示例

JSON格式

{
  "HostId": "1",
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
400LicenseOutOfLimitThe host count is out of limit.-
500InternalErrorAn unknown error occurred.未知错误

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

变更历史

变更时间变更内容概要操作
2023-11-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:NetworkDomainId
  • 本页导读 (1)
文档反馈