Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

获取全局 API 密钥的所有角色

在此页面上

  • Resource
  • 所需角色
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

返回全局 API密钥的可接受全局角色列表。

基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /admin/apiKeys/roles

要求调用此端点的API密钥具有 Global Read Only角色。

此端点不使用 HTTP 请求路径参数。

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

名称
类型
说明
默认
pageNum
整型
页码(从 1 开始)。
1
itemsPerPage
整型
每页要返回的项目数,最多 500 个。
100
pretty
布尔
指示响应正文是否应采用 prettyprint 格式。
false
envelope
布尔

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

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

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

名称
说明
status
HTTP 响应代码
content
预期响应正文

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

返回全局API密钥的所有可接受的全局角色的数组。

注意

发出请求的用户可以采用{PUBLIC-KEY}:{PRIVATE-KEY}格式。

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?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}
1{
2 [
3 "GLOBAL_BACKUP_ADMIN",
4 "GLOBAL_BILLING_ADMIN",
5 "GLOBAL_MONITORING_ADMIN",
6 "GLOBAL_READ_ONLY",
7 "GLOBAL_AUTOMATION_ADMIN",
8 "GLOBAL_USER_ADMIN"
9 ]
10}

后退

获取所有全局 API 密钥