您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
集合可讓您將 API Proxy、目標或開發人員應用程式分組,並為群組的所有成員設定適當的門檻值,藉此更快診斷問題。
以下各節說明如何使用 API 管理集合。
如要進一步瞭解集合 API,請參閱 Collections API。
使用 API 建立集合
向下列資源發出 POST 要求,建立 API Proxy 集合: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
值指定為 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"