文档

ListHostGroups - 获取主机组列表

更新时间:

可以获取主机组列表。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/hostGroups

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https:// devops.aliyun.com/organization/【OrgId】

5ebbc0228123212b59xxxxx
idsstring

主机组 id,多个逗号分割

121,1212121232
createStartTimelong

主机组创建时间

1586863220000
createEndTimelong

主机组结束时间

1586863220000
namestring

主机组名称

主机组
creatorAccountIdsstring

创建阿里云账号 id,多个逗号分割

1112122121,3223332
nextTokenstring

分页 token

221212221
maxResultslong

结果返回个数

30
pageSortstring

排序条件 ID

ID
pageOrderstring

排序顺序 DESC 降序 ASC 升序

DESC

返回参数

名称类型描述示例值
object
requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMessagestring

错误信息

""
errorCodestring

错误码

""
successboolean

true 接口调用成功,false 接口调用失败

true
hostGroupsarray<object>

主机组

object
creatorAccountIdstring

创建人阿里云账号 id

2222222222222
updateTimelong

更新时间

1586863220000
hostNumlong

主机个数

3
modifierAccountIdstring

修改人阿里云账号 id

211111111
descriptionstring

描述

主机组
typestring

类型

ECS
createTimelong

主机时间

1586863220000
ecsTypestring

主机类型

ECS_ALIYUN
aliyunRegionstring

阿里云区域

cn-beijing
ecsLabelKeystring

ecs 标签 Key

ecs
namestring

部署组名称

部署组
idlong

部署组 Id

444xxxx
serviceConnectionIdlong

服务连接 Id

1212122
ecsLabelValuestring

Ecs 标签值

value
totalCountlong

总数

50
nextTokenstring

分页 token,空表示最后一页

asassasassa

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMessage": "\"\"",
  "errorCode": "\"\"",
  "success": true,
  "hostGroups": [
    {
      "creatorAccountId": "2222222222222",
      "updateTime": 1586863220000,
      "hostNum": 3,
      "modifierAccountId": "211111111",
      "description": "主机组",
      "type": "ECS",
      "createTime": 1586863220000,
      "ecsType": "ECS_ALIYUN",
      "aliyunRegion": "cn-beijing",
      "ecsLabelKey": "ecs",
      "name": "部署组",
      "id": 0,
      "serviceConnectionId": 1212122,
      "ecsLabelValue": "value"
    }
  ],
  "totalCount": 50,
  "nextToken": "asassasassa"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史