Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
エージェント

1 つのプロジェクトのすべてのエージェント API キーを取得

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/agentapikeys

このエンドポイントは、 Project Read Onlyロールを持つユーザーに制限されています。

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

名前
タイプ
説明
プロジェクトID
string
エージェント API キーを所有するプロジェクトの一意の識別子。

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

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
false
envelope
ブール値
任意

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

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

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

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

リクエスト ボディ パラメータ

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

応答

名前
タイプ
説明
id
string
このエージェント API キーの一意の識別子。
キー
string

エージェント API キー。

このエージェント API キーを作成すると、後続のリクエストによってエージェント API キーの最後の 4 文字が返されます。

desc
string
このエージェント API キーのラベル。 1,000 文字に制限されます。
createdTime
string
ISO8601 のタイムスタンプ エージェント API キーが作成されたときの UTC の日付と時刻形式。
createdUserId
string
このエージェント API キーを作成したユーザーの一意の識別子。
createdIpAddr
string
このエージェント API キーを作成したIPアドレス。
createdBy
string

このエージェント API キーのソース。 指定できる値は以下のとおりです。

  • USER

  • OLD_KEY

  • PROVISIONING

  • ATLAS

  • PUBLIC_API

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?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}

レスポンス本体

[ {
  "_id" : "{AGENT-API-KEY-ID-1}",
  "createdBy" : "PUBLIC_API",
  "createdIpAddr" : "{IP-ADDRESS-1}",
  "createdTime" : 1520458807291,
  "createdUserId" : "{USER-ID-1}",
  "desc" : "Agent API Key for this project",
  "key" : "****************************8b87"
}, {
  "_id" : "{AGENT-API-KEY-ID-2}",
  "createdBy" : "PROVISIONING",
  "createdTime" : 1508871142864,
  "desc" : "Generated by Provisioning",
  "key" : "****************************39fe"
}, {
  "_id" : "{AGENT-API-KEY-ID-3}",
  "createdBy" : "USER",
  "createdIpAddr" : "{IP-ADDRESS-2}",
  "createdTime" : 1507067499083,
  "createdUserId" : "{USER-ID-2}",
  "desc" : "Initial API Key",
  "key" : "****************************70d7"
} ]

戻る

APIキーの作成

次へ

APIキーの削除