Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

将所有团队纳入一个项目

在此页面上

  • 语法
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

注意:群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/teams
路径元素
必需/可选
说明
PROJECT-ID
必需。
项目的唯一标识符。

以下查询参数为可选参数:

名称
类型
必要性
说明
默认
pageNum
数字
Optional
从一开始的整数,用于返回结果的一部分。
1
itemsPerPage
数字
Optional
每页要返回的项目数,最多 500 个。
100
pretty
布尔
Optional
指示响应正文是否应采用 prettyprint 格式 的标志 格式。
false
envelope
布尔
Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 envelope : true

对于返回结果列表的端点, results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

false
backupJobsEnabledOnly
布尔
Optional
指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为false以包含将backupJobsEnabled标志设置为false的守护进程配置。
true

此端点不使用 HTTP 请求正文参数。

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明
results
阵列
数组为results嵌入式文档部分中详细介绍的每一项包含一个对象。
links
阵列
数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
totalCount
数字
结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。

result数组中的每个元素都是分配给该项目的一个团队。

名称
类型
说明
links
对象数组

此数组包括一个或多个指向子资源和/或相关资源的链接

URL 之间的关系在 Web 链接规范中进行了解释。

roleNames
字符串数组
分配给团队的项目角色数组。
teamId
字符串
团队的唯一标识符。
curl -u "username:apiKey" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request GET "{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams?pretty=true"
HTTP/1.1 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
HTTP/1.1 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}
{
"links": [
{
"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams",
"rel": "self"
}
],
"results": [
{
"links" : [
{
"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID}",
"rel": "self"
}
],
"roleNames": [
"GROUP_READ_ONLY"
],
"teamId": "{TEAM-ID}"
}
],
"totalCount": 1
}

后退

更新一个项目邀请