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

在此页面上

Resource

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

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

注意

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

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/byAgentApiKey/{AGENT-API-KEY}

请求参数

请求路径参数

名称	类型	说明
代理API密钥	字符串	（必需。）代理 API 密钥

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观打印的标志格式。

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 \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byAgentApiKey/{AGENT-API-KEY}?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}

响应体

{
  "id": "{PROJECT-ID}",
  "name": "My Project",
  "orgId" : "{ORG-ID}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2
  },
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "activeAgentCount": 1,
  "replicaSetCount": 3,
  "shardCount": 2,
  "publicApiEnabled": true,
  "agentApiKey": "{AGENT-API-KEY}",
  "links" : []
}

后退

按名称获取一个项目

来年

创建一个项目