基本 URL： https://cloud.mongodb.com/api/public/v1.0
Resource
POST /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/accessList请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 目标服务帐户所属组织的唯一标识符。使用 /orgs 端点检索经过身份验证的用户有权访问权限的所有组织。 |
| 字符串 | 要为其创建新的访问权限列表条目的组织服务帐户的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 说明 | 默认 |
|---|---|---|---|
pageNum | 整型 | 页码（从 1 开始）。 |
|
itemsPerPage | 整型 | 每页要返回的项目数，最多 500 个。 |
|
pretty | 布尔 | 指示是否以 prettyprint 格式返回响应正文。 |
|
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回一个结果的终结点，响应体包括：
对于返回结果列表的端点， | 无 |
请求正文参数
指定一个文档数组，其中每个文档代表要添加到项目中的一个访问列表条目。 即使仅将单个访问列表条目与项目关联，也必须指定一个数组。
当您提交的POST请求包含访问权限列表中尚未存在的ipAddress或cidrBlock值时， Cloud Manager会将这些条目添加到访问权限列表的现有条目列表中。 Cloud Manager不会设立访问权限列表设置为仅包含请求中指定的条目。
在下表中， [i]表示数组索引。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 要添加到服务帐户访问权限列表的IP解决。 此字段与 |
| 字符串 | 要为服务账户添加的访问列表条目，以 CIDR 表示法表示。此字段与 |
响应
响应文档
响应 JSON 文档包括 result 对象数组、link 对象数组和检索到的 result 对象的总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
results数组中的每个对象都是一个访问列表条目。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 访问列表中以 CIDR 表示的 IP 地址范围。 |
| 数字 | 源自此 IP 地址的请求总数。 |
| 日期 | 将此 IP 地址添加到访问列表的日期。 |
| 字符串 | 访问列表中的 IP 地址。 |
| 日期 | 源自此 IP 地址的最近一次请求的日期。 仅当至少有一个请求源自此 IP 地址时，此字段才会出现，并且仅在从访问列表检索资源时才会更新。 |
| 字符串 | 上次调用 API 的 IP 地址。 仅当至少有一个请求源自此 IP 地址时，才会显示此字段。 |
请求示例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/accessList?pretty=true" \ --data ' [{ "ipAddress" : "77.54.32.11" }]'响应示例
响应标头
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-aliveHTTP/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/{ORG-ID}/serviceAccounts/{CLIENT-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "cidrBlock" : "206.252.195.126/32", "requestCount" : 47, "createdAt" : "2019-01-24T16:26:37Z", "ipAddress" : "206.252.195.126", "lastUsed" : "2019-01-25T16:32:47Z", "lastUsedAddress" : "206.252.195.126"
} ], "totalCount" : 1}