通过 OpenAPI 更新主机组。
适用版本 | 标准版 |
服务接入点与授权信息
获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID 。
产品
资源
所需权限
流水线
主机组
读写
请求语法
PUT https://{domain}/oapi/v1/flow/organizations/{organizationId}/hostGroups请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 组织 Id。 | 5ebbc0228123212b59xxxxx |
id | integer | query | 是 | 主机组 id。 | 123 |
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.0.0.0”}] |
请求示例
curl -X 'PUT' \
'https://test.rdc.aliyuncs.com/oapi/v1/flow/organizations/5ebbc0408123212b59d58347/hostGroups?id=249699&type=ECS&name=20241128test2&serviceConnectionId=400582' \
-d 'machineInfos=[{"aliyunRegionId":"cn-qingdao","machineSn":"i-m5eal4ftjuz2ptk4j0zf","instanceName":"jenkins-pipeline-test","ip":"172.31.101.97"}]' \
-H 'x-yunxiao-token: pt-l2HCAF4A8M6pQoerCtSFuWMG_7da1cb22-aef4-4617-a0c0-41a54141edbe' 返回参数
参数 | 类型 | 描述 | 示例值 |
- | boolean | 是否成功。 | true |
返回示例
true错误码
访问错误码中心查看 API 相关错误码。