MongoDB Ops Manager のすべてのグローバルAPIキーを返します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys必須のロール
このエンドポイントとなる接続されたデバイスを呼び出すAPIキーがGlobal Read Onlyロールを持っている必要があります。
Request Parameters
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つの API キーです。
名前 | タイプ | 説明 |
|---|---|---|
| string | このグローバルAPIキーの説明。 |
| string | このグローバルAPIキーの一意の識別子。 |
| string | ドキュメントの配列は、1 つまたは複数のサブリソースまたは関連リソース ( リストのページネーション など) への リンク を表現します。詳細については、連携を参照してください。 |
| string | このグローバルAPIキーの編集済み秘密キー。 |
| string | このグローバルAPIキーの公開キー。 |
| オブジェクト配列 | このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。 |
| string | ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。
|
リクエストの例
注意
リクエストを行うユーザーは、 {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?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}レスポンス本体
{ "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "desc" : "Test Global API Key 1", "id" : "5d669ce780eef52a42cf0e1e", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", "rel" : "self" } ], "privateKey" : "********-****-****-54d9792d337d", "publicKey" : "zrefxaep", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" } ] }, { "desc" : "Test Global API Key 2", "id" : "5d6fec4180eef54728814b14", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14", "rel" : "self" } ], "privateKey" : "********-****-****-fe646723a586", "publicKey" : "qlgofmne", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" } ] }, { "desc" : "Test Global API Key 3", "id" : "5d6fecfc80eef547288207f3", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3", "rel" : "self" } ], "privateKey" : "********-****-****-fe348ed1796f", "publicKey" : "cfswjfck", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" }, { "roleName" : "GLOBAL_USER_ADMIN" } ] } ], "totalCount" : 3}