エージェント API キーによる 1 つのプロジェクトの取得

項目一覧

Resource

Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/byAgentApiKey/{AGENT-API-KEY}

Request Parameters

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

名前	タイプ	説明
Agent-API-KEY	string	（必須。）エージェント API キー

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ形式。

false

envelope

ブール値

任意

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

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

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

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

false

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

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

応答

名前

タイプ

説明

ActiveAgentCount

integer

MongoDB Ops Manager に定期的に ping を送信するアクティブなエージェントの数。

値は約24時間ごとに更新され、キャッシュされます。新しいエージェントを開始するか、既存のエージェントを停止した場合、変更がactiveAgentCountフィールドに表示されるまでに最大30分かかることがあります。

hostCounts

オブジェクト

タイプ別のホストの合計数。埋め込みフィールドは自己説明型である必要があります。

string

プロジェクトの一意の識別子です。

lastActiveAgent

string

MongoDB Ops Managerがプロジェクトの activeAgentCount の合計を最後に更新した時間。 MongoDB Ops Manager は 24 時間ごとにこの値を更新し、アクティブな MongoDB エージェントの数を記録するためにキャッシュします。

ldapGroupMappings

オブジェクト配列

ベースの LDAPMongoDB Ops Managerの場合、LDAP プロジェクトロールへのグループのマッピング。MongoDB Ops ManagerLDAP ベースのMongoDB Ops Managerにのみ存在します。

ldapGroupMappings

.roleName

string

MongoDB Ops Manager ユーザーロール。プロジェクトロールのroleNameへのマッピングは次のとおりです。

ユーザーロール	`roleName` 値
`Project Owner` （必須）	`GROUP_OWNER`
`Project Automation Admin`	`GROUP_AUTOMATION_ADMIN`
`Project Backup Admin`	`GROUP_BACKUP_ADMIN`
`Project Monitoring Admin`	`GROUP_MONITORING_ADMIN`
`Project Data Access Admin`	`GROUP_DATA_ACCESS_ADMIN`
`Project Data Access Read/Write`	`GROUP_DATA_ACCESS_READ_WRITE`
`Project Data Access Read Only`	`GROUP_DATA_ACCESS_READ_ONLY`
`Project Read Only`	`GROUP_READ_ONLY`

ldapGroupMappings

.ldapGroups

string 配列

MongoDB Ops Manager ロールにマッピングする LDAP プロジェクト。

Links

オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。

name

string

プロジェクトの表示名。

orgId

string

プロジェクトが属する組織のユニーク識別子。

publicApiEnabled

ブール値

このプロジェクトでAPIが有効になっていることを示すフラグ。これは常にtrueである読み取り専用フィールドです。

replicaSetCount

integer

このプロジェクトのレプリカセットの合計数。

shardCount

integer

このプロジェクトのシャードの合計数。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/byAgentApiKey/{AGENT-API-KEY}?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": "{PROJECT-ID}",
  "name": "My Project",
  "orgId" : "{ORG-ID}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2
  },
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "activeAgentCount": 1,
  "replicaSetCount": 3,
  "shardCount": 2,
  "publicApiEnabled": true,
  "agentApiKey": "{AGENT-API-KEY}",
  "tags": [ "DEV", "PRODUCT" ],
  "ldapGroupMappings" : [ {
    "roleName": "GROUP_OWNER",
    "ldapGroups": [  project-owner" ]
    }, ... ],
  "links" : []
}

戻る

名前を使用して取得

作成

注意

Resource

Request Parameters

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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