按名称获取一个项目

注意

群组和项目是同义术语。您的 {PROJECT-ID} 与您的群组 ID（group ID）相同。对于现有群组，您的群组/项目 ID 保持不变。当引用说明时，此页面使用更为人熟知的术语“群组”。终结点保持不变，如文档中所述。

基本 URL： https://cloud.mongodb.com/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	整型	定期向Cloud Manager发送 ping 的活动代理数量。该值大约每24小时刷新并缓存。如果启动新代理或停止现有代理，则更改最多可能需要30分钟才能显示在`activeAgentCount`字段中。
hostCounts	对象	按类型划分的主机总数。嵌入式字段应该是不言自明的。
id	字符串	群组的唯一标识符。
lastActiveAgent	字符串	Time Cloud Manager 上次更新项目的`activeAgentCount`总计。 Cloud Manager 每24小时刷新并缓存该值，以记录活动 MongoDB 助手的数量。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
名称	字符串	项目的显示名称。
orgId	字符串	项目所属组织的唯一标识符。
publicApiEnabled	布尔	指示此项目已启用 API 的标志。这是一个只读字段，始终为 `true`。
replicaSetCount	整型	此项目的副本集总数。
shardCount	整型	此项目的分片总数。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --include \     --request GET "https://cloud.mongodb.com/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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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}",  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),  "links" : [],  "name": "My Project",  "orgId" : "111111111cccccf38dc78bdf",  "publicApiEnabled": true,  "replicaSetCount": 3,  "shardCount": 2,}