获取所有组织

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

Resource

GET /orgs

请求参数

请求路径参数

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

请求查询参数

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

名称	类型	说明	默认
`pageNum`	整型	页码（从 1 开始）。	`1`
`itemsPerPage`	整型	每页要返回的项目数，最多 500 个。	`100`
`pretty`	布尔	以美观打印格式显示响应。	`false`
`envelope`	布尔	指定是否将响应包装在信封中。	`false`
`name`	字符串	根据指定的组织名称筛选结果。对与指定`name`完全匹配的组织执行不区分大小写的搜索。示例，如果您指定的`name`查询参数为`org1` ， Cloud Manager将返回名为`org1`和`Org1`的组织，但不会返回名为`org123`的组织。	无

请求正文参数

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

响应

响应文档

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

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

`results` 嵌入式文档

每个结果都是一个组织。

名称	类型	说明
id	字符串	组织的唯一标识符。
isDeleted	布尔	指示组织是否已删除的标志。
名称	字符串	组织名称。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \     --header 'Accept: application/json' \     --include \     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/"

响应示例

响应标头

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/orgs",    "rel" : "self"  }],  "results" : [    {      "id" : "{ORG-ID1}",      "isDeleted": false,      "links": [{
      }],      "name" : "Internal Application Support"    },    {      "id" : "{ORG-ID2}",      "isDeleted": false,      "links": [{
      }],      "name" : "Customer Application Support"    },    {      "id" : "{ORG-ID3}",      "isDeleted": false,      "links": [{
      }],      "name" : "Research and Development"    }  ],  "totalCount" : 3}