创建一个代理 API 密钥
2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
Resource
POST /groups/{PROJECT-ID}/agentapikeys
此端点仅限具有 Project Owner角色的用户使用。
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
PROJECT-ID | 字符串 | 拥有代理 API 密钥的项目的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
名称 | 类型 | 说明 |
|---|---|---|
desc | 字符串 | 此代理 API 密钥的标签。 |
响应
名称 | 类型 | 说明 |
|---|---|---|
id | 字符串 | 此代理 API 密钥的唯一标识符。 |
key | 字符串 | 代理 API 密钥。 创建此代理 API 密钥后，后续请求将返回代理 API 密钥的最后四个字符。 |
desc | 字符串 | 此代理 API 密钥的标签。 限制为 1,000 个字符。 |
createdTime | 字符串 | ISO8601 格式的时间戳 创建代理 API 密钥时的日期和时间格式（ UTC 格式）。 |
createdUserId | 字符串 | 创建此代理 API 密钥的用户的唯一标识符。 |
createdIpAddr | 字符串 | 创建此代理 API 密钥的IP地址。 |
createdBy | 字符串 | 此代理 API 密钥的来源。 接受的值为：
|
请求示例
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/groups/{PROJECT-ID}/agentapikeys?pretty=true" \ --data ' { "desc": "Agent API Key for this project" }'
响应示例
响应标头
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}
响应体
{ "_id" : "{AGENT-API-KEY-ID}", "createdBy" : "PUBLIC_API", "createdIpAddr" : "{IP-ADDRESS}", "createdTime" : 1520458807291, "createdUserId" : "{USER-ID}", "desc" : "Agent API Key for this project", "key" : "{AGENT-API-KEY}" }