Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
プログラム API キー
/
グローバル プログラマティック API キー

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

項目一覧

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

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 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

各結果は 1 つの API キーです。

名前
タイプ
説明
desc
string
このグローバルAPIキーの説明。
id
string
このグローバルAPIキーの一意の識別子。
links
string
1 つ以上のサブリソースや関連リソース（ リストページ 分割 など）への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。
privateKey
string
このグローバルAPIキーの編集済み秘密キー。
publicKey
string
このグローバルAPIキーの公開キー。
roles
オブジェクト配列
このグローバルAPIキーが持つロール。 この配列は、MongoDB Ops Manager でユーザーが持っているすべてのグローバル ロールを返します。
roles.roleName
string

ロールの名前。 このリソースは、MongoDB Ops Manager でユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。

API のロール値
ロール
GLOBAL_AUTOMATION_ADMIN
GLOBAL_BACKUP_ADMIN
GLOBAL_MONITORING_ADMIN
GLOBAL_OWNER
GLOBAL_READ_ONLY
GLOBAL_USER_ADMIN

リクエストの例

注意

リクエストを行うユーザーは、 {USERNAME}:{APIKEY}または{PUBLIC-KEY}:{PRIVATE-KEY}として指定できます。

1curl --user "{USERNAME}:{APIKEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?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  "links" : [ {
3    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4    "rel" : "self"
5  } ],
6  "results" : [ {
7    "desc" : "Test Global API Key 1",
8    "id" : "5d669ce780eef52a42cf0e1e",
9    "links" : [ {
10      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
11      "rel" : "self"
12    } ],
13    "privateKey" : "********-****-****-54d9792d337d",
14    "publicKey" : "zrefxaep",
15    "roles" : [ {
16      "roleName" : "GLOBAL_READ_ONLY"
17    }, {
18      "roleName" : "GLOBAL_BILLING_ADMIN"
19    } ]
20  }, {
21    "desc" : "Test Global API Key 2",
22    "id" : "5d6fec4180eef54728814b14",
23    "links" : [ {
24      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14",
25      "rel" : "self"
26    } ],
27    "privateKey" : "********-****-****-fe646723a586",
28    "publicKey" : "qlgofmne",
29    "roles" : [ {
30      "roleName" : "GLOBAL_READ_ONLY"
31    } ]
32  }, {
33    "desc" : "Test Global API Key 3",
34    "id" : "5d6fecfc80eef547288207f3",
35    "links" : [ {
36      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3",
37      "rel" : "self"
38    } ],
39    "privateKey" : "********-****-****-fe348ed1796f",
40    "publicKey" : "cfswjfck",
41    "roles" : [ {
42      "roleName" : "GLOBAL_READ_ONLY"
43    }, {
44      "roleName" : "GLOBAL_BILLING_ADMIN"
45    }, {
46      "roleName" : "GLOBAL_USER_ADMIN"
47    } ]
48  } ],
49  "totalCount" : 3
50}

戻る

グローバル プログラマティック API キー

次へ

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