キーの一意の識別子を使用して、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
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | 検索対象のグローバルAPIキーの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答要素
名前 | タイプ | 説明 |
|---|---|---|
| string | このグローバルAPIキーの説明。 |
| string | このグローバルAPIキーの一意の識別子。 |
| string | ドキュメントの配列は、1 つまたは複数のサブリソースまたは関連リソース ( リストのページネーション など) への リンク を表現します。詳細については、連携を参照してください。 |
| string | このグローバルAPIキーの編集済み秘密キー。 |
| string | このグローバルAPIキーの公開キー。 |
| オブジェクト配列 | このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。 |
| string | ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。
|
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?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}レスポンス本体
{ "desc" : "Test Global API Key 1", "id" : "{API-KEY-ID}", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}", "rel" : "self" } ], "privateKey" : "********-****-****-54d9792d337d", "publicKey" : "zrefxaep", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" } ]}