Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
编程 API 密钥。
/
组织API密钥

获取一个 API 密钥

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应元素
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}

请求路径参数

名称
类型
说明

ORG-ID

字符串

要检索其 API 密钥的组织的唯一标识符。 使用/orgs端点检索经过身份验证的用户有权访问的所有组织。

API-KEY-ID

字符串

要检索的API 密钥的唯一标识符。 请求/orgs/{ORG-ID}/apiKeys端点检索经过身份验证的用户有权访问的指定组织的所有 API密钥。

请求查询参数

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

名称
类型
说明
默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

每页要返回的项目数，最多 500 个。

100

pretty

布尔

指示响应正文是否应采用 美观打印 格式。

false

envelope

布尔

指示是否要将响应封装在信封中。

某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题，请在查询中设置"envelope" : true 。

对于返回一个结果的终结点，响应体包括：

名称
说明

status

HTTP 响应代码

content

预期响应正文

对于返回结果列表的端点，results 对象是一个信封。Cloud Manager 将 status 字段添加到响应正文。

无

请求正文参数

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

响应

响应元素

如果将查询元素envelope设置为true ，则响应将由content对象包装。

HTTP 响应返回一个 JSON document，其中包含以下对象：

名称
类型
说明

id

字符串

API 密钥的唯一标识符

links

字符串

文档数组，表示一个或多个子资源和/或相关资源（例如 列表分页 ）的 链接 。有关详细信息，请参阅链接。

desc

字符串

API 密钥的描述

privateKey

字符串

已编辑 API 密钥的私钥

publicKey

字符串

API 密钥的公钥

roles

对象数组

API 密钥具有的角色

roles.{ENTITY-ID}

字符串

{ENTITY-ID}代表此角色适用的组织或项目。 可能的值为： orgId或groupId 。

roles.roleName

字符串

角色的名称。users 资源返回用户在 MongoDB Atlas 或 Cloud Manager 中拥有的所有角色。可能的值为：

请求示例

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}/apiKeys/{API-KEY-ID}?pretty=true"

响应示例

响应标头

HTTP/1.1 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
HTTP/1.1 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}

响应体

{
  "desc" : "Test Docs Service User",
  "id" : "5c47503880eef5662e1cce8d",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98229d82e3f6/apiKeys/5c47503880eef5662e1cce8d",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "ewmaqvdo",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_READ_ONLY"
  }, {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_OWNER"
  } ]
}

后退

获取全部

来年

Update