返回全局API密钥的可接受全局角色列表。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys/roles所需角色
要求调用此终结点的 API 密钥具有 Global Read Only 角色。
请求参数
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 说明 | 默认 |
|---|---|---|---|
pageNum | 整型 | 页码(从 1 开始)。 |
|
itemsPerPage | 整型 | 每页要返回的项目数,最多 500 个。 |
|
pretty | 布尔 | 指示显示正文是否应采用 prettyprint 格式。 |
|
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回一个结果的终结点,响应体包括:
对于返回结果列表的端点, | 无 |
响应
返回全局API密钥的所有可接受的全局角色的数组。
请求示例
注意
发出请求的用户可以采用{PUBLIC-KEY}:{PRIVATE-KEY}格式。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?pretty=true"响应示例
响应标头
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}响应体
{ [ "GLOBAL_BACKUP_ADMIN", "GLOBAL_BILLING_ADMIN", "GLOBAL_MONITORING_ADMIN", "GLOBAL_READ_ONLY", "GLOBAL_AUTOMATION_ADMIN", "GLOBAL_USER_ADMIN" ]}