現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
コレクションを使用すると、API プロキシ、ターゲット、デベロッパー アプリをグループ化し、グループのすべてのメンバーに適切なしきい値を設定して、問題をより迅速に診断できます。
以降のセクションでは、API を使用してコレクションを管理する方法について説明します。
Collections API について詳しくは、Collections API をご覧ください。
API を使用したコレクションの作成
https://apimonitoring.enterprise.apigee.com/collections リソースに POST リクエストを発行して、API プロキシのコレクションを作成します。
次の例は、コレクションの作成方法を示しています。
curl 'https://apimonitoring.enterprise.apigee.com/collections' \
-X POST \
-H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
"organization":"myorg",
"name":"My Collection",
"description":"My collection for critical APIs",
"environment": "prod",
"type": "proxy",
"members":["proxy1", "proxy2"]
}'
OAuth 2.0 アクセス トークンの取得の説明に従って、$ACCESS_TOKEN を OAuth 2.0 アクセス トークンに設定します。
この例で使用されている cURL オプションについては、cURL を使用するをご覧ください。
type の値は proxy、target、または developerApp として指定できます。たとえば、デベロッパー アプリのコレクションを作成するには、次のようにします。
curl 'https://apimonitoring.enterprise.apigee.com/collections' \
-X POST \
-H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json"\
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
"organization":"myorg",
"name":"My Dev App Collection",
"description":"My collection for critical apps",
"environment": "prod",
"type": "developerApp",
"members":["app1", "app2"]
}'
API を使用してすべてのコレクションを表示する
次のリソースに GET リクエストを発行して、すべてのアラートと通知を表示します: https://apimonitoring.enterprise.apigee.com/collections
org クエリ パラメータを使用して、組織の名前を渡す必要があります。
例:
curl 'https://apimonitoring.enterprise.apigee.com/collections?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"
レスポンスの例を次に示します。
[{
"uuid":"1234abcd",
"organization":"myorg",
"environment": "prod",
"name":"My Collection",
"type": "proxy",
"members":["proxy1", "proxy2"],
"description":"My collection for critical APIs",
"updatedAt":"2018-07-13T16:25:15Z",
"updatedBy":"joe@acme.com"
}]
OAuth 2.0 アクセス トークンの取得の説明に従って、$ACCESS_TOKEN を OAuth 2.0 アクセス トークンに設定します。
この例で使用されている cURL オプションについては、cURL を使用するをご覧ください。
特定のコレクションを表示するには、コレクションの uuid を /collections リソースに追加します。
curl 'https://apimonitoring.enterprise.apigee.com/collections/1234abcd?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"