API を使用したコレクションの管理

コレクションを使用すると、API プロキシ、ターゲット、デベロッパー アプリをグループ化し、グループのすべてのメンバーに適切なしきい値を設定して、問題を迅速に診断できます。

以降のセクションでは、API を使用してコレクションを管理する方法について説明します。

コレクション API の詳細については、コレクション API をご覧ください。

API を使用してコレクションを作成する

次のリソースに POST リクエストを発行して、API プロキシのコレクションを作成します。 https://apimonitoring.enterprise.apigee.com/collections

次の例は、コレクションの作成方法を示しています。

    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 値には、proxytarget、または 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"