获取所有服务帐户项目分配
2024 年 8 月 30 日以后,Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
基本 URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/groups
请求路径参数
名称 | 类型 | 说明 |
---|---|---|
ORG-ID | 字符串 | 要检索其服务帐户的组织的唯一标识符。使用 /orgs 端点检索经过身份验证的用户有权访问权限的所有组织。 |
CLIENT-ID | 字符串 | 要检索的服务帐户的唯一标识符。请求 /orgs/{ORG- ID}/serviceAccounts 端点检索经过身份验证的用户有权访问权限的指定组织的所有服务帐户。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | 整型 | 页码(从 1 开始)。 | 1 | ||||||
itemsPerPage | 整型 | 每页要返回的项目数,最多 500 个。 | 100 | ||||||
pretty | 布尔 | 指示响应正文是否应采用 美观打印 格式。 | false | ||||||
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回一个结果的终结点,响应体包括:
对于返回结果列表的端点, | 无 |
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是分配给该服务帐户的一个项目。
名称 | 类型 | 说明 |
---|---|---|
groupId | 字符串 | 已分配项目的唯一标识符。 |
请求示例
注意
发出请求的用户可以采用{PUBLIC-KEY}:{PRIVATE-KEY}
格式。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/groups/?pretty=true"
响应示例
响应标头
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
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}
响应体
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/1234567890abcdef12345678/serviceAccounts/mdb_sa_id_66ae38803cdf55582cb01144/groups/?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "groupId" : "66ae30345fe4416479e39269" } ] }, { "groupId" : "79ih30345ks4416479e39464" } ] }, { "groupId" : "35ih30345pw4416479e30732" } ] } ], "totalCount": 3 }