按名称获取一个项目

在此页面上

Resource

请求参数
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例

注意

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

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

Resource

GET /groups/byName/{GROUP-NAME}

请求参数

请求路径参数

名称	类型	说明
GROUP-NAME	字符串	（必需。）项目名称。

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

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

响应

名称

类型

说明

ActiveAgentCount

整型

定期向 Ops Manager 发送网络探测（ping）的活动代理数量。

该值大约每24小时刷新并缓存。如果启动新代理或停止现有代理，则更改最多可能需要30分钟才能显示在activeAgentCount字段中。

hostCounts

对象

按类型划分的主机总数。嵌入式字段应该是不言自明的。

字符串

项目的唯一标识符。

lastActiveAgent

字符串

时间 Ops Manager 上次更新了项目的activeAgentCount总计。 Ops Manager 每 24 小时刷新并缓存该值，以记录活动 MongoDB 代理的数量。

ldapGroupMappings

对象数组

对于LDAP支持的MongoDB Ops Manager ， LDAP群组到MongoDB Ops Manager项目角色的映射。仅适用于LDAP支持的MongoDB Ops Manager 。

ldapGroupMappings

.roleName

字符串

Ops Manager user role. 项目角色到roleName的映射如下：

用户角色	`roleName` 值
`Project Owner` （必需）	`GROUP_OWNER`
`Project Automation Admin`	`GROUP_AUTOMATION_ADMIN`
`Project Backup Admin`	`GROUP_BACKUP_ADMIN`
`Project Monitoring Admin`	`GROUP_MONITORING_ADMIN`
`Project Data Access Admin`	`GROUP_DATA_ACCESS_ADMIN`
`Project Data Access Read/Write`	`GROUP_DATA_ACCESS_READ_WRITE`
`Project Data Access Read Only`	`GROUP_DATA_ACCESS_READ_ONLY`
`Project Read Only`	`GROUP_READ_ONLY`

ldapGroupMappings

.ldapGroups

字符串数组

映射到 Ops Manager 角色的 LDAP 项目。

链接

对象数组

指向子资源和/或相关资源的一个或多个链接。响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

名称

字符串

项目的显示名称。

orgId

字符串

项目所属组织的唯一标识符。

publicApiEnabled

布尔

指示为此项目启用API的标志。这是一个始终为true的只读字段。

replicaSetCount

整型

此项目的副本集总数。

shardCount

整型

此项目的分片总数。

标记

字符串数组

分配给项目的标签，用于以编程方式标识项目。

要查看标签，您必须具有Project Read Only角色。
要创建或编辑标签，您必须具有Project Automation Admin角色。

一个项目最多可以有 10 个标签。标签遵循以下规则：

区分大小写
可以包含以下字符：
- A 通过 Z
- 0 通过 9
- . （句点）
- _ （下划线）
- - （破折号）
限制为 32 个字符

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"

重要

URL 中不允许使用某些字符。这些字符称为保留字符。如果您的{GROUP-NAME} 包含保留字符（例如空格），则必须将其替换为相应的百分号编码。

示例，不发出此请求（通过 curl）：

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"

发出此请求（通过 curl）：

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?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}

响应体

{
  "activeAgentCount": 1,
  "agentApiKey": "{AGENT-API-KEY}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2
  },
  "id": "{PROJECT-ID}",
  "ldapGroupMappings" : [ {
    "roleName": "GROUP_OWNER",
    "ldapGroups": [  project-owner" ]
    }, ... ],
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "links" : [],
  "name": "My Project",
  "orgId" : "111111111cccccf38dc78bdf",
  "publicApiEnabled": true,
  "replicaSetCount": 3,
  "shardCount": 2,
  "tags": [ "DEV", "PRODUCT" ]
}

后退

通过 ID 获取一个项目

来年

通过代理 API 密钥获取一个项目