如何使用主机组GetHostGroup-获取主机组_云效(Apsara Devops)-阿里云帮助中心

可以获取主机组。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /organization/{organizationId}/hostGroups/{id}

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】	5ebbc0228123212b59xxxxx
id	long	是	主机组 id	21221

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMessage	string	错误信息	""
errorCode	string	错误码	""
success	boolean	true 接口调用成功，false 接口调用失败	true
hostGroup	object	主机组
creatorAccountId	string	创建者阿里云账号 id	111111
upateTIme	long	更新时间	1586863220000
hostNum	long	主机数	1
modifierAccountId	string	修改者阿里云账号 id	11111
description	string	主机组描述	主机组描述
type	string	主机组类型	ECS
createTime	long	创建时间	1586863220000
ecsType	string	ecs 类型，暂只支持 ECS_ALIYUN	ECS_ALIYUN
aliyunRegion	string	阿里云区域	cn-bejing
ecsLabelKey	string	ecs 标签 Key	ecs
id	long	主机组 id	1234
name	string	主机组名称	主机组名称
serviceConnectionId	long	服务连接 id	1234
hostInfos	object []	主机信息
updateTime	long	更新时间	1586863220000
creatorAccountId	string	创建者阿里云账号	11111
instanceName	string	主机名	ceshi
modifierAccountId	string	修改者阿里云账号	11111111111
ip	string	机器 ip	127.0.0.1
createTime	long	创建时间	1586863220000
objectType	string	MachineInfo 值固定为 MachineInfo	MachineInfo
aliyunRegionId	string	阿里云区域	cn-hangzhou
machineSn	string	机器 sn	1ssasa
ecsLabelValue	string	ecs 标签 value	ecs

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMessage": "\"\"",
  "errorCode": "\"\"",
  "success": true,
  "hostGroup": {
    "creatorAccountId": "111111",
    "upateTIme": 1586863220000,
    "hostNum": 1,
    "modifierAccountId": "11111",
    "description": "主机组描述",
    "type": "ECS",
    "createTime": 1586863220000,
    "ecsType": "ECS_ALIYUN",
    "aliyunRegion": "cn-bejing",
    "ecsLabelKey": "ecs",
    "id": 1234,
    "name": "主机组名称",
    "serviceConnectionId": 1234,
    "hostInfos": [
      {
        "updateTime": 1586863220000,
        "creatorAccountId": "11111",
        "instanceName": "ceshi",
        "modifierAccountId": "11111111111",
        "ip": "127.0.0.1",
        "createTime": 1586863220000,
        "objectType": "MachineInfo",
        "aliyunRegionId": "cn-hangzhou",
        "machineSn": "1ssasa"
      }
    ],
    "ecsLabelValue": "ecs"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParam.ParamNotPresent	The parameter is invalid.	参数有误，请检查参数
400	InvalidUser.NotFound	The user that is invoking the API service is not a registered user.	调用 API 的用户，未注册为云效用户
403	Forbidden.UserNotInCurrentOrganization	The user is not in the organization and is not authorized to perform the operation.	当前用户不在该企业中，无权进行操作。
404	InvalidOrganization.NotFound	The organization is not found.	企业不存在，请检查企业ID是否正确

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史