获取组织中的所有项目

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

Resource

GET /orgs/{ORG-ID}/groups

请求参数

请求路径参数

路径元素	类型	说明
ORG-ID	必需。	要检索其信息的组织的唯一标识符。

请求查询参数

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

名称	类型	说明	默认
`pageNum`	整型	页码（从 1 开始）。	`1`
`itemsPerPage`	整型	每页要返回的项目数，最多 500 个。	`100`
`pretty`	布尔	以美观打印格式显示响应。	`false`
`envelope`	布尔	指定是否将响应包装在信封中。	`false`
`name`	字符串	用于筛选返回列表的项目的人类可读标签。对组织内以指定`name`为前缀的项目执行不区分大小写的搜索。示例，如果您指定`project1`的`name`查询参数， Cloud Manager将返回名为`project1`的项目，但不会返回名为`project123`的项目。	无

请求正文参数

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

响应

响应文档

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

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

`results` 嵌入式文档

每个结果都是一个项目。

名称	类型	说明
ActiveAgentCount	整型	项目中活动监控、自动化和备份的数量。
hostCounts	文档	描述集群的主机类型以及每种主机类型的数量。
hostCounts.arbiter	整型	集群中仲裁节点主机的数量。
hostCounts.config	整型	集群中分片集群配置服务器主机的数量。
hostCounts.mongos	整型	集群中 `mongos` 托管的数量。
hostCounts.primary	整型	集群中主节点 (primary node in the replica set)节点主机的数量。
hostCounts.secondary	整型	集群中从节点主机的数量。
id	字符串	项目的唯一标识符。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
名称	字符串	集群的名称。
orgId	字符串	项目父组织的唯一标识符。
publicApiEnabled	布尔	API 对集群的访问状态。
replicaSetCount	整型	集群中副本集的数量。
shardCount	整型	集群中分片的数量。

请求示例

curl --user "{username:apiKey}" \     --include \     --header "Content-Type: application/json" \     --digest GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups"

响应示例

响应标头

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": [{
  }],  "results": [{    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 1,      "secondary": 2      },    "id": "{PROJECT-ID}",    "links": [{
    }],    "name": "Production Cluster",    "orgId": "{ORG-ID}",    "publicApiEnabled": true,    "replicaSetCount": 1,    "shardCount": 0  },  {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 1,      "secondary": 2    },    "id": "{PROJECT-ID}",    "lastActiveAgent": "2017-10-26T02:39:59Z",    "links": [{
    }],    "name": "Staging Cluster",    "orgId": "{ORG-ID}",    "publicApiEnabled": true,    "replicaSetCount": 1,    "shardCount": 0    }  ],  "totalCount": 2}