返回一个组织的AI模型API密钥 | Atlas Admin API v2 文档（预览版）

返回一个组织的AI模型API密钥预览

获取 /api/atlas/v2/orgs/{orgId}/aiModelApiKeys

服务账户 DigestAuth

此API处于预览状态。在发布之前可能会引入重大更改。不要在生产环境中使用预览版 API。

检索给定组织的AI模型API密钥。

路径参数

orgId 字符串必需

唯一的 24-十六进制数字字符串，用于标识包含项目的组织。使用 /orgs 端点检索身份验证的用户有权访问权限的所有组织。

格式应符合以下模式：^([a-f0-9]{24})$。

查询参数

itemsPerPage 整型

响应每页返回的列项数。

最小值为 1，最大值为 500。默认值为 100。
pageNum 整型

显示响应返回的当前总对象集的页面编号。

最小值为 1。默认值为 1。
envelope 布尔

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

默认值为false 。
pretty 布尔

指示响应正文是否应采用 prettyprint 格式的标记。

默认值为false 。

Prettyprint

响应

200 application/vnd.atlas.preview+json

正常
隐藏响应属性显示响应属性对象
- 链接大量[对象]
  
  点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。
  
  Web 链接规范 (RFC...
  
  隐藏链接属性显示链接属性对象
  
  href 字符串
  
  统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
  
  rel 字符串
  
  统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
- 结果大量[对象]
  
  MongoDB Cloud 在完成此请求时提供的返回文档列表。
  
  隐藏结果属性显示结果属性对象
  
  apiKeyId 字符串
  
  用于在管理API调用中引用此API密钥的标识符。
  
  createdAt 字符串
  
  创建API密钥时的 UTC 日期。此参数的格式为 ISO 8601 时间戳。
  
  createdBy 字符串
  
  创建此API密钥的用户名称。如果没有可用的用户名，则返回用户ID 。
  
  groupId 字符串
  
  此API密钥所属的Atlas群组的ID 。
  
  lastUsedAt 字符串
  
  上次使用API密钥时的 UTC 日期。此参数的格式为 ISO 8601 时间戳。
  
  maskedSecret 字符串
  
  创建API密钥时返回的API密钥密钥的部分模糊版本。
  
  名称字符串
  
  为便于识别而分配给此API密钥的任意字符串标识符。
  
  最小长度为 1，最大长度为 250。
  
  秘密 string(password)
  
  用于与嵌入/重新排名服务交互的完整API密钥。注意：只有在创建API密钥请求的响应中才会完整填充此项。对获取、列出和更新请求的响应将不包含密钥。
  
  状态字符串
  
  描述API密钥当前状态的字符串。
- 总计数 integer(int32)
  
  可用文档总数。如果 includeCount设立为 false，MongoDB Cloud 会忽略此值。总数为估计值，可能不准确。
  
  最小值为 0。
401 application/json

未经授权。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
403 application/json

Forbidden.
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
404 application/json

未找到。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
500 application/json

内部服务器错误。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

GET /api/atlas/v2 /orgs/{orgId}/aiModelApiKeys

atlas api aiModels listOrgModelKeys --help

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.preview+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/aiModelApiKeys?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.preview+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/aiModelApiKeys?pretty=true"

响应示例 (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "apiKeyId": "a86r5kwrfsk5r5ku5tgvhmpj",
      "createdAt": "2026-01-15T16:47:49.855000+00:00",
      "createdBy": "John Doe",
      "groupId": "69681d39c9e8cfd375386316",
      "lastUsedAt": "2026-01-15T16:47:49.855000+00:00",
      "maskedSecret": "al-****odu2",
      "name": "Production key",
      "secret": "al-jZsluhPMzPM9CFXepRWwMwvpZDDra6tZMgoAZKdodu2",
      "status": "ACTIVE"
    }
  ],
  "totalCount": 42
}

响应示例 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

响应示例 (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

响应示例 (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

响应示例 (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

返回一个组织的AI模型API密钥 预览

路径参数

查询参数

响应

返回一个组织的AI模型API密钥预览