Apigee Hybrid API ドキュメント

一般には、Apigee Edge API のほとんどが Apigee Hybrid 組織でサポートされています。 ハイブリッドに固有の公開 API の一部を以下に示します。ハイブリッドに対してサポートされていない API のリストについては、サポートされていない API をご覧ください。

組織内の API プロキシのデプロイに関する詳細を取得する

組織内のすべての環境における API プロキシのデプロイに関する詳細のリストを返します。レスポンスには、各環境内のプロキシのデプロイ ステータスが含まれています。デプロイ ステータスとして使用される戻り値は deployed と error です。

使用可能なクエリ パラメータ

次の表に、この API のクエリ パラメータを示します。すべてのパラメータが必須です。

名前 型 説明
proxySubtype enum

API プロキシと共有フローを区別します。

proxySubtype として使用される値を以下に示します。

  • apiProxy
  • sharedFlow
proxyName 文字列 デプロイの詳細を要求する API プロキシの名前。
revision int API プロキシのリビジョン番号。

リソース URL

https://api.enterprise.apigee.com/v1/organizations/org_name/events/deploymentstatus?proxySubtype=proxy_subtype&proxyName=proxy_name&revision=revision

例:

https://api.enterprise.apigee.com/v1/organizations/hybridOrg/events/deploymentstatus?proxySubtype=apiProxy&proxyName=proxy1&revision=8

リソースの概要

次の表に、この API に対するリクエストの要件を示します。
サポートされているセキュリティ タイプ Basic 認証または OAuth2
Content-Type リクエスト ヘッダー 「application/json」または「text/xml」に設定します。
Accept リクエスト ヘッダー 「application/json」または「application/xml」に設定します。

サンプル レスポンス

  {
  "deployments": [
    {
      "environment": "staging",
      "eventTime": "1550034032",
      "podName": "ashga_6576_as",
      "appVersion": "180608_10",
      "proxySubType": "apiProxy",
      "proxyName": "proxy1",
      "revision": "8",
      "statusDetails": {
        "deploymentStatus": "deployed",
        "statusCode": "200",
        "statusCodeDetails": "reason text here",
        "deploymentTime": "1550034032",
        "data": [
          {
            "name": "value"
          }
        ]
      }
    },
    {
      "environment": "staging",
      "eventTime": "1550034032",
      "podName": "ashga_6577_as",
      "appVersion": "180608_10",
      "proxySubType": "apiProxy",
      "proxyName": "proxy1",
      "revision": "8",
      "statusDetails": {
        "deploymentStatus": "deployed",
        "statusCode": "200",
        "statusCodeDetails": "reason text here",
        "deploymentTime": "1550034032",
        "data": [
          {
            "name": "value"
          }
        ]
      }
    },
    {
      "environment": "prod",
      "eventTime": "1550038979",
      "podName": "ashga_6578_as",
      "appVersion": "180608_10",
      "proxySubType": "apiProxy",
      "proxyName": "proxy1",
      "revision": "8",
      "statusDetails": {
        "deploymentStatus": "deployed",
        "statusCode": "200",
        "statusCodeDetails": "reason text here",
        "deploymentTime": "1550033567",
        "data": [
          {
            "name": "value"
          }
        ]
      }
    },
    {
      "environment": "prod",
      "eventTime": "1550038979",
      "podName": "ashga_6579_as",
      "appVersion": "180608_10",
      "proxySubType": "apiProxy",
      "proxyName": "proxy1",
      "revision": "8",
      "statusDetails": {
        "deploymentStatus": "deployed",
        "statusCode": "200",
        "statusCodeDetails": "reason text here",
        "deploymentTime": "1550033567",
        "data": [
          {
            "name": "value"
          }
        ]
      }
    }
  ]
}

環境内の API プロキシのデプロイの詳細を取得する

指定された環境での API プロキシのデプロイに関する詳細のリストを返します。レスポンスには、プロキシのデプロイ ステータスが含まれています。デプロイ ステータスとして使用される戻り値は deployed と error です。

使用可能なクエリ パラメータ

次の表に、この API のクエリ パラメータを示します。すべてのパラメータが必須です。

名前 型 説明
proxySubtype enum

API プロキシと共有フローを区別します。

proxySubtype として使用される値を以下に示します。

  • apiProxy
  • sharedFlow
proxyName 文字列 デプロイの詳細を要求する API プロキシの名前。
revision int API プロキシのリビジョン番号。

リソース URL

https://api.enterprise.apigee.com/v1/organizations/org_name/environments/environment/events/deploymentstatus?proxySubtype=proxy_subtype&proxyName=proxy_name&revision=revision

例:

https://api.enterprise.apigee.com/v1/organizations/hybridOrg/environments/prod/events/deploymentstatus?proxySubtype=apiProxy&proxyName=proxy1&revision=8

リソースの概要

次の表に、この API に対するリクエストの要件を示します。
サポートされているセキュリティ タイプ Basic 認証または OAuth2
Content-Type リクエスト ヘッダー 「application/json」または「text/xml」に設定します。
Accept リクエスト ヘッダー 「application/json」または「application/xml」に設定します。

サンプル レスポンス

{
  "deployments": [
    {
      "environment": "prod",
      "eventTime": "1550038979",
      "podName": "ashga_6578_as",
      "appVersion": "180608_10",
      "proxySubType": "apiProxy",
      "proxyName": "proxy1",
      "revision": "8",
      "statusDetails": {
        "deploymentStatus": "deployed",
        "statusCode": "200",
        "statusCodeDetails": "reason text here",
        "deploymentTime": "1550033567",
        "data": [
          {
            "name": "value"
          }
        ]
      }
    },
    {
      "environment": "prod",
      "eventTime": "1550038979",
      "podName": "ashga_6579_as",
      "appVersion": "180608_10",
      "proxySubType": "apiProxy",
      "proxyName": "proxy1",
      "revision": "8",
      "statusDetails": {
        "deploymentStatus": "deployed",
        "statusCode": "200",
        "statusCodeDetails": "reason text here",
        "deploymentTime": "1550033567",
        "data": [
          {
            "name": "value"
          }
        ]
      }
    }
  ]
}

組織のポッドに関する詳細を取得する

特定の組織内のすべてのポッドに関する詳細のリストを返します。

リソース URL

https://api.enterprise.apigee.com/v1/organizations/org_name/events/poddetails

例:

https://api.enterprise.apigee.com/v1/organizations/hybridOrg/events/poddetails

リソースの概要

次の表に、この API に対するリクエストの要件を示します。
サポートされているセキュリティ タイプ Basic 認証または OAuth2
Content-Type リクエスト ヘッダー 「application/json」または「text/xml」に設定します。
Accept リクエスト ヘッダー 「application/json」または「application/xml」に設定します。

サンプル レスポンス

[
{
"organization" : "test-org"
"environment" : "test-env"
"podName" : "pod1"
"eventTime" : 1554225246196
},
{
"organization" : "test-org"
"environment" : "test-env"
"podName" : "pod2"
"eventTime" : 1554225246196
}
...
...
...
]