1 つのグローバル API キーを取得
項目一覧
MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。 可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。
キーの一意の識別子を使用して、MongoDB Ops Manager の 1 つのグローバル APIキーを返します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys/{API-KEY-ID}
必須のロール
このエンドポイントを呼び出すAPIキーに Global Read Onlyロールが必要です。
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
API-KEY-ID | string | 検索対象のグローバルAPIキーの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答要素
名前 | タイプ | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | string | このグローバルAPIキーの説明。 | ||||||||||||||
id | string | このグローバルAPIキーの一意の識別子。 | ||||||||||||||
links | string | |||||||||||||||
privateKey | string | このグローバルAPIキーの編集済み秘密キー。 | ||||||||||||||
publicKey | string | このグローバルAPIキーの公開キー。 | ||||||||||||||
roles | オブジェクト配列 | このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。 | ||||||||||||||
roles.roleName | string | ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。
|
リクエストの例
1 curl --user "{USERNAME}:{APIKEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"
応答例
応答ヘッダー
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
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 "desc" : "Test Global API Key 1", 3 "id" : "{API-KEY-ID}", 4 "links" : [ { 5 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}", 6 "rel" : "self" 7 } ], 8 "privateKey" : "********-****-****-54d9792d337d", 9 "publicKey" : "zrefxaep", 10 "roles" : [ { 11 "roleName" : "GLOBAL_READ_ONLY" 12 }, { 13 "roleName" : "GLOBAL_BILLING_ADMIN" 14 } ] 15 }