为当前用户获取所有带有特定标签的项目
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
资源
GET /groups
请求参数
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 说明 |
---|---|---|
标签 | 字符串 | 分配给项目的标签,用于以编程方式标识项目。
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应 JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个项目。
名称 | 类型 | 说明 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActiveAgentCount | 整型 | 定期向 Ops Manager 发送网络探测(ping)的活动代理数量。 该值大约每24小时刷新并缓存。如果启动新代理或停止现有代理,则更改最多可能需要30分钟才能显示在 | ||||||||||||||||||
hostCounts | 对象 | 按类型划分的主机总数。嵌入式字段应该是不言自明的。 | ||||||||||||||||||
id | 字符串 | 项目的唯一标识符。 | ||||||||||||||||||
lastActiveAgent | 字符串 | 时间 Ops Manager 上次更新了项目的 activeAgentCount 总计。 Ops Manager 每 24 小时刷新并缓存该值,以记录活动 MongoDB 代理的数量。 | ||||||||||||||||||
ldapGroupMappings | 对象数组 | 对于支持 LDAP 的 Ops Manager,这是LDAP 群组到 Ops Manager 项目角色的映射。 仅适用于支持 LDAP 的 Ops Manager。 | ||||||||||||||||||
ldapGroupMappings .roleName | 字符串 | Ops Manager user role. 项目角色到
| ||||||||||||||||||
ldapGroupMappings .ldapGroups | 字符串数组 | 映射到 Ops Manager 角色的 LDAP 项目。 | ||||||||||||||||||
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。响应中的所有 | ||||||||||||||||||
名称 | 字符串 | 项目的显示名称。 | ||||||||||||||||||
orgId | 字符串 | 项目所属组织的唯一标识符。 | ||||||||||||||||||
publicApiEnabled | 布尔 | 指示为此项目启用API的标志。 这是一个始终为 true 的只读字段。 | ||||||||||||||||||
replicaSetCount | 整型 | 此项目的副本集总数。 | ||||||||||||||||||
shardCount | 整型 | 此项目的分片总数。 | ||||||||||||||||||
标记 | 字符串数组 | 分配给项目的标签,用于以编程方式标识项目。
一个项目最多可以有 10 个标签。 标签遵循以下规则:
|
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?tag=ABC&tag=DEF&pretty=true"
响应示例
响应标头
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
响应体
1 { 2 "links": [], 3 "results": [{ 4 "id": "xxx", 5 "name": "My Project", 6 "orgId": "111111111cccccf38dc78bdf", 7 "hostCounts": { 8 "arbiter": 2, 9 "config": 1, 10 "primary": 4, 11 "secondary": 8, 12 "mongos": 2 13 }, 14 "lastActiveAgent": "2016-08-05T07:23:34Z", 15 "activeAgentCount": 1, 16 "replicaSetCount": 3, 17 "shardCount": 2, 18 "publicApiEnabled": true, 19 "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e", 20 "tags": ["ABC", "DEF"], 21 "ldapGroupMappings": [{ 22 "roleName": "GROUP_OWNER", 23 "ldapGroups": [ project-owner"] 24 }], 25 "links": [] 26 } 27 ], 28 "totalCount": 1 29 }