启用 Apigee Monetization

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

您必须先在组织中购买并启用 Apigee Monetization，然后才能使用此功能。

购买 Apigee Monetization

如需为基于订阅的组织购买 Apigee Monetization：

  1. 验证您的 Apigee 订阅是否包含 Apigee Monetization。请参阅 Apigee 权益。
  2. 如果需要，请与 Apigee 销售人员联系以购买 Apigee Monetization。

在您的组织中启用 Apigee Monetization

如需在现有组织中启用 Apigee Monetization，请向以下 API 发出 POST 请求，从而在请求正文中传递插件配置：

https://apigee.googleapis.com/v1/organizations/$ORG:setAddons

例如：

curl "https://apigee.googleapis.com/v1/organizations/$ORG: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/operations/1ae3ed56-b38f-4cc1-ba33-e7d89557075d",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

如需了解详情，请参阅配置组织插件 API。

查看组织配置文件以确认 Monetization 已启用。例如：

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

以下提供了一个响应示例，表明 Monetization 已启用。

{
    "name": $ORG,
    ...
    "addonsConfig": {
    "monetizationConfig": {
      "enabled": true
    }
  }
}

在组织中停用 Apigee Monetization

如需在您的组织中停用 Apigee Monetization，请向以下 API 发出 POST 请求，从而在请求正文中传递插件配置：

https://apigee.googleapis.com/v1/organizations/$ORG:setAddons

例如：

curl "https://apigee.googleapis.com/v1/organizations/$ORG: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/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

如需了解详情，请参阅配置组织插件 API。

查看组织配置文件以确认 Monetization 已停用。例如：

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

以下提供了一个响应示例，表明 Monetization 已启用。

{
    "name": $ORG,
    ...
    "addonsConfig": {
    "monetizationConfig": {
      "enabled": false
    }
  }
}

Apigee Monetization 启用问题排查

如果您尚未购买 Apigee Monetization，并尝试将其启用，将返回以下错误：

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