对于 AI 代理：可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

获取当前用户的所有项目

注意

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

基本 URL： https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups

请求参数

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

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

名称
类型
必要性
说明
默认

pageNum

数字

Optional

从一开始的整数，用于返回结果的一部分。

1

itemsPerPage

数字

Optional

每页要返回的项目数，最多 500 个。

100

pretty

布尔

Optional

false

envelope

布尔

Optional

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

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

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

false

backupJobsEnabledOnly

布尔

Optional

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

true

请求正文参数

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

响应

响应文档

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

名称
类型
说明

results

阵列

数组为results 嵌入式文档 部分中详细介绍的每一项包含一个对象。

links

阵列

数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

totalCount

数字

结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。

results 嵌入式文档

每个结果都是一个项目。

名称
类型
说明

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?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}

响应体

{  "links": [{    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",    "rel": "self"  }, {    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",    "rel": "next"  }],  "results": [{    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56a10a80e4b0fd3b9a9bb0c2",    "lastActiveAgent": "2016-03-09T18:19:37Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "012i3091203jioawjioej",    "orgId": "5980cfdf0b6d97029d82f86e",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa691ce4b0a0e8c4be51f7",    "lastActiveAgent": "2016-01-29T19:02:56Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454008603036",    "orgId": "5980d0040b6d97029d831798",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa6dfde4b0fe328eee82ad",    "lastActiveAgent": "2016-01-29T20:34:28Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454009852809",    "orgId": "5980d0040b6d97029d831799",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa8421e4b0d04c1c54df99",    "lastActiveAgent": "2016-01-29T21:36:10Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454015520776",    "orgId": "5980d0040b6d97029d83179a",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa85f9e4b0d04c1c54e347",    "lastActiveAgent": "2016-01-29T21:36:10Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454015992252",    "orgId": "5980d0040b6d97029d83179b",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }],  "totalCount": 5}
后退
项目
来年
通过ID获取
给本页内容打分

在此页面上