CreateHostGroup - 创建主机组

通过 OpenAPI 创建主机组。

适用版本

标准版

服务接入点与授权信息

  • 获取服务接入点,替换 API 请求语法中的 <domain> :服务接入点(domain)

  • 获取个人访问令牌,具体操作,请参见获取个人访问令牌

  • 获取organizationId,请前往组织管理后台基本信息页面获取组织 ID 。

    产品

    资源

    所需权限

    流水线

    主机组

    读写

请求语法

POST https://{domain}/oapi/v1/flow/organizations/{organizationId}/hostGroups

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

企业 Id。

5ebbc0228123212b59xxxxx

type

string

query

主机组类型,暂只支持 ECS。

ECS

envId

string

query

环境 id。

0

name

string

query

主机组名称。

主机组

serviceConnectionId

integer

query

服务连接 id。

123

tagIds

string

query

标签 id,多个逗号分割。

12,234

ecsType

string

query

ECS 类型,暂支持 ECS_ALIYUN。

ECS_ALIYUN

ecsLabelKey

string

query

ecs 标签 key。

ecs

ecsLabelValue

string

query

ecs 标签 value。

ecs

aliyunRegion

string

query

阿里云 region。

cn-beijing

machineInfos

string

query

aliyunRegionId 机器所在 aliyun region,machineSn 机器的 sn, instanceName,主机名,ip 主机 ip。

[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.x.x.x"}]

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/flow/organizations/5ebbc0228123212b59xxxxx/hostGroups?type=ECS&envId=0&name=主机组&serviceConnectionId=123&tagIds=12,234&ecsType=ECS_ALIYUN&ecsLabelKey=ecs&ecsLabelValue=ecs&aliyunRegion=cn-beijing' \
  -d 'machineInfos=[{"aliyunRegionId":"cn-beijing","machineSn":"i-sssssss","instanceName":"ceshi","ip":"120.x.x.x"}]' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

integer

主机组 id。

123

返回示例

123

错误码

访问错误码中心查看 API 相关错误码。