Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API リソース
/
サービス アカウント
/
組織のプログラマティック サービス アカウント アクセス リスト

1 つの組織サービス アカウントのすべてのアクセス リスト エントリを取得

項目一覧

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

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

指定されたサービス アカウントのすべてのアクセス リスト エントリに関する情報を取得します。

Resource

GET /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/accessList

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

名前
タイプ
説明
ORG-ID
string
ターゲット サービス アカウントが属する組織の一意の識別子です。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントをリクエストします。
CLIENT-ID
string
アクセス リスト エントリを取得するサービス アカウントのユニーク識別子です。 認証済みユーザーがアクセスできる指定された組織のすべてのサービス アカウントを取得するには、 /orgs/{ORG- ID }/serviceAccounts エンドポイントをリクエストします。

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

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

名前
タイプ
説明
default
pageNum
integer
ページ番号（1 インデックス ベース）。
1
itemsPerPage
integer
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
false
envelope
ブール値

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

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

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

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

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

なし

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

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

応答

応答ドキュメント

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

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

results embeddedDocument

各結果は 1 つのアクセス リスト エントリです。

名前
タイプ
説明
cidrBlock
string
アクセス リスト内の IP アドレスの CIDR 表記範囲。
requestCount
数値
この IP アドレスから送信されたリクエストの合計数。
createdAt
date
この IP アドレスがアクセス リストに追加された日付。
ipAddress
string
アクセス リスト内の IP アドレス。
lastUsedAt
date
この IP アドレスから送信された最新のリクエストの日付。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから送信された場合にのみ表示され、アクセス リストからリソースが検索されたときにのみ更新されます。
lastUsedAddress
string
API への最後の呼び出しが発行された IP アドレス。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから発生した場合にのみ表示されます。
links
配列
1 つ以上のサブリソースや関連リソース（ リストページ 分割 など）への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/accessList?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://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}/accessList/?pretty=true&pageNum=1&itemsPerPage=100",
4  "rel" : "self"
5  } ],
6  "results" : [ {
7    "cidrBlock" : "147.58.184.16/32",
8    "requestCount" : 0,
9    "createdAt" : "2019-01-24T16:34:57Z",
10    "ipAddress" : "147.58.184.16",
11    "lastUsed" : "2019-01-24T20:18:25Z",
12    "lastUsedAddress": "147.58.184.16"
13  }, {
14    "cidrBlock" : "84.255.48.125/32",
15    "requestCount" : 0,
16    "createdAt" : "2019-01-24T16:26:37Z",
17    "ipAddress" : null,
18    "lastUsed" : "2019-01-24T20:18:25Z",
19    "lastUsedAddress": "84.255.48.125"
20  } ],
21  "totalCount" : 2
22}

戻る

組織のプログラマティック サービス アカウント アクセス リスト

次へ

1 つの組織サービス アカウントのアクセス リスト エントリを作成