You need to enable JavaScript to run this app.
导航
云堡垒机
  • 文档首页
    • /
  • 云堡垒机

CreateHostGroup

最近更新时间：2024.04.16 19:47:30

首次发布时间：2023.12.15 10:45:21

我的收藏

创建主机组，可通过主机组批量管理主机。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=CreateHostGroup&Version=2021-06-01

请求参数

参数类型是否必选示例值描述
ActionString是CreateHostGroup接口名称。当前 API 的名称为 CreateHostGroup。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
HostGroupNameString是vbh-node-group主机组名称。
InstanceIdString是vbh-14****0042-bhjml9w7云堡垒机 ID。
DescriptionString否host group for vbh users.主机组描述信息。
HostIdsArray of String否["2e7d77da-af08-41**-****-e44259701efb"]主机ID列表。

请求示例

POST https://open.volcengineapi.com/?Action=CreateHostGroup&Version=2021-06-01
Content-Type: application/json
{
    "HostGroupName": "vbh-node-group",
    "InstanceId": "vbh-14****0042-bhjml9w7",
    "Description": "host group for vbh users.",
    "HostIds": ["2e7d77da-af08-41**-****-e44259701efb"]
}

返回参数

参数类型示例值描述
HostGroupIdString2e7d77da-af08-41**-****-e44259701efb主机组 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "CreateHostGroup",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "HostGroupId": "2e7d77da-af08-41**-****-e44259701efb"
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考 公共错误码 进行故障排查。