CreateHostGroup--云堡垒机-火山引擎

文档中心

立即注册

导航

CreateHostGroup

最近更新时间：2025.05.23 17:57:31首次发布时间：2023.12.15 10:45:21

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

请求说明

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

请求参数

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

请求示例

POST https://vbh.{RegionID}.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"
    ]
}

返回参数

参数	类型	示例值	描述
HostGroupId	String	2e7d77da-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"
    }
}

错误码

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