Apigee 収益化を有効にする

このページは ApigeeApigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

Apigee 収益化を使用するには、購入して組織内で有効にする必要があります。Apigee 収益化は、Apigee 環境と Apigee ハイブリッド環境でサポートされています。

Apigee 収益化を購入する

サブスクリプション組織で Apigee 収益化を購入するには、Apigee セールスに連絡し、組織で Apigee 収益化を有効にします

Apigee の収益化は、従量課金制組織では利用できません。

Apigee の評価組織には、トライアル期間中の Apigee 収益化トライアルが自動的に含まれます。収益化を追加するために Apigee セールスにご連絡いただく必要はありません。組織で Apigee 収益化を有効にするに進みます。

組織で Apigee 収益化を有効にする

既存の組織で Apigee 収益化を有効にするには、次の API に POST リクエストを発行して、リクエストの本文でアドオン構成を渡します。

https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons

次に例を示します。

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "monetizationConfig": {
          "enabled": "true"
      }
      <Include existing add-on configuration>
    }
  }'

ここで、OAuth 2.0 アクセス トークンの取得で説明されているように、$TOKEN は OAuth 2.0 アクセス トークンに設定されます。この例で使用されている curl オプションの詳細については、curl の使用をご覧ください。使用できる環境変数の説明については、Apigee API リクエストの環境変数の設定をご覧ください。

次に、オペレーションが進行中であることを示すレスポンスの例を示します。

{
  "name": "organizations/ORG_NAME/operations/1ae3ed56-b38f-4cc1-ba33-e7d89557075d",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/ORG_NAME",
    "state": "IN_PROGRESS"
  }
}

詳細については、組織のアドオン API を構成するをご覧ください。

組織プロファイルを表示して、収益化が有効になっているかを確認します。次に例を示します。

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

次の例は、収益化が有効になっているレスポンスの例です。

{
    "name": ORG_NAME,
    ...
    "addonsConfig": {
    "monetizationConfig": {
      "enabled": true
    }
  }
}

組織で Apigee 収益化を無効にする

組織で Apigee 収益化を無効にするには、次の API に POST リクエストを発行し、リクエスト本文でアドオン構成を渡します。

https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons

次に例を示します。

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "monetizationConfig": {
          "enabled": "false"
      }
     <Include existing add-on configuration>
    }
  }'

次に、オペレーションが進行中であることを示すレスポンスの例を示します。

{
  "name": "organizations/ORG_NAME/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/ORG_NAME",
    "state": "IN_PROGRESS"
  }
}

詳細については、組織のアドオン API を構成するをご覧ください。

組織のプロフィールを表示して、収益化が無効になっていることを確認します。次に例を示します。

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

次の例は、収益化が有効になっているレスポンスの例です。

{
    "name": ORG_NAME,
    ...
    "addonsConfig": {
    "monetizationConfig": {
      "enabled": false
    }
  }
}

Apigee 収益化の有効化に関するトラブルシューティング

Apigee 収益化サービスを購入してないまま有効にしようとすると、次のエラーが返されます。

{
  "error": {
    "code": 400,
    "message": "failed to validate addons config: [Apigee Monetization] addon(s) are not entitled to the subscription",
    "status": "FAILED_PRECONDITION"
  }
}