グローバル API キーのすべてのロールを取得

項目一覧

Resource

必須のロール
Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

グローバル APIキーに受け入れ可能なグローバルロールのリストを返します。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /admin/apiKeys/roles

必須のロール

このエンドポイントを呼び出すAPIキーに Global Read Onlyロールが必要です。

Request Parameters

リクエストパスパラメーター

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体を pretty-print に含めるかどうかを示します形式。

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

なし

応答

グローバルAPIキーに受け入れ可能なすべてのグローバルロールの配列を返します。

リクエストの例

注意

リクエストを行うユーザーは、 {PUBLIC-KEY}:{PRIVATE-KEY}としてフォーマットできます。

1 curl --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 キーを取得する

1 つのグローバル API キーを取得

1	curl --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"

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	}