管理 API 产品的费率方案

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

使用费率方案，API 产品所有者可以通过配置以下内容来利用其 API 产品获利：

  • 结算账号模型
  • 用于结算的币种
  • 客户结算的频率（仅限每月）
  • 使用 API 产品的初始设置费用
  • 使用 API 产品的基于消耗的扣款
  • 任何不基于使用量的周期性费用，例如 API 产品的每月使用费
  • 费率方案对 API 产品有效的时间间隔（费率方案激活和到期时间）
  • 与开发者合作伙伴的收益分成

按照以下几个部分中的说明管理您的 API 产品的费率方案。

查看费率方案

按照以下几个部分中的说明查看您组织的费率方案。

Cloud 控制台中的 Apigee

按照以下几个部分中的说明使用 Cloud 控制台中的 Apigee 界面查看费率方案：

查看为您的组织定义的费率方案

在“费率方案”页面上查看为您的组织定义的费率方案。

要访问“费率方案”页面，请执行以下操作：

  1. 登录 Cloud 控制台中的 Apigee 界面。
  2. 在侧边导航栏中，依次选择分发 > 创收。

“费率方案”页面会打开，其中列出当前的费率方案。

费率方案列表，其中显示费率方案名称、API 产品、各自的激活时间和到期时间，以及可用于管理费率方案的菜单

借助“费率方案”页面，您可以：

查看与 API 产品关联的费率方案

管理 API 产品时，您可以查看和管理与 API 产品关联的费率方案。向下滚动到费率方案部分，查看费率方案。

经典版 Apigee 界面

按照以下几个部分中的说明使用界面查看费率方案：

查看为您的组织定义的费率方案

在“费率方案”页面上查看为您的组织定义的费率方案。

要访问“费率方案”页面，请执行以下操作：

  1. 登录经典版 Apigee 界面。
  2. 在侧边导航栏中选择发布 > 创收 > 费率方案。

“费率方案”页面会列出当前的费率方案。

费率方案列表，其中显示费率方案名称、API 产品、各自的激活时间和到期时间，以及可用于管理费率方案的下拉列表

在“费率方案”页面上，您可以：

查看与 API 产品关联的费率方案

管理 API 产品时，您可以查看和管理与 API 产品关联的费率方案。修改 API 产品，然后向下滚动到费率方案部分。

Apigee API

以下几个部分介绍如何使用 API 查看组织的费率方案：

使用 API 列出 API 产品的费率方案

如需列出组织的费率方案，请向以下 API 发出 GET 请求：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

例如，使用 curl：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans?expand=true" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

下面是一个响应输出示例，其中包括与 HelloworldProduct API 产品关联的两个费率方案：myrateplan1 和 myrateplan2：

{
    "ratePlans": [
        {
            "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan2",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "setupFee": {
                "currencyCode": "USD",
                "units": "20"
            },
            "fixedRecurringFee": {
                "currencyCode": "USD",
                "units": "25"
            },
            "fixedFeeFrequency": 1,
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "nanos": 500000000
                    }
                }
            ],
            "revenueShareType": "FIXED",
            "revenueShareRates": [
                {
                    "sharePercentage": 2
                }
            ],
            "state": "DRAFT"
        },
        {
            "name": "8c0b527c-ba2f-45f1-ac1c-b9e891546fc2",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan1",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "units": "3"
                    }
                }
            ],
            "state": "PUBLISHED",
            "startTime": "1617302588000"
        }
    ]
}

如需详细了解 API 及其响应载荷，请参阅 List Rate Plans API

使用 API 查看费率方案的详细信息

如需查看费率方案的详细信息，请向以下 API 发出 GET 请求：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

如需确定要在资源路径中传递的费率方案的名称，请参阅列出组织中的费率方案。

例如，使用 curl：

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

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

下面的示例显示名为 6b51b501-ac15-41b7-bb3e-621edb849e13 且显示名为 myrateplan2 的费率方案的响应输出：

{
    "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan2",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "20"
    },
    "fixedRecurringFee": {
        "currencyCode": "USD",
        "units": "25"
    },
    "fixedFeeFrequency": 1,
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "nanos": 500000000
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 2
        }
    ],
    "state": "DRAFT"
}

如需详细了解 API 及其响应载荷，请参阅获取费率方案 API。

创建费率方案

按照以下几个部分中的说明创建费率方案。

Cloud 控制台中的 Apigee

如需使用 Cloud 控制台中的 Apigee 界面创建费率方案，请执行以下操作：

  1. 执行以下任务之一：
    • 在侧边导航栏中依次选择分发 > 创收，然后点击费率方案列表中的创建。
    • 修改 API 产品，然后点击费率方案部分中的添加费率方案。
  2. 输入费率方案详细信息，如下所示：
    字段 说明
    费率方案名称 输入费率方案的名称。
    API 产品 从下拉列表中选择要与费率方案关联的 API 产品。
  3. 点击下一步。
  4. 输入结算详细信息，如下所示：
    字段 说明 默认
    结算币种 从下拉列表中选择要用于结算的币种。 美元
    结算周期 从下拉列表中选择客户结算的频率。 每月
    初始化费用

    在费率方案开始日期（即开发者购买 API 产品的日期）向每个开发者收取的一次性费用。

    如果要收取设置费用，请选择收取初始化费用，然后在初始化费用字段中输入要收取的金额。

    		 已停用
  5. 点击下一步。
  6. 输入价格详细信息，如下所示。
    字段 说明 默认
    固定周期性费用 启用每单位固定周期性费用：
    1. 选择收取固定周期性费用。
    2. 配置固定费用频率和固定周期性费用金额。

    我们会在第一个结算周期按比例收取费用。

    启用后，您可以预览固定周期性费用对分项扣款和总扣款的影响，如预览费率方案中所述。

    如需停用这项费用，请取消选择收取固定周期性费用。

    		已停用
    基于用量的费用。 启用基于消耗的价格：
    1. 选择收取基于消耗的费用。
    2. 选择以下任一选项：
      • 每单位固定费用（对使用的每个单位收取固定费用）
      • 区间（对使用的每个单位收取可变费用，由用量范围决定）

    • 每单位固定费用：对每个获利事务收取固定费用。 在每单位固定费用字段中输入一个值，这是对每个事务收取的费用。

    • 区间：对每个获利事务收取可变费用。事务区间和用量决定一个事务的费用。区间是指 API 用量范围，每个区间收取不同的费用。 在 Ranges of unit consumption 部分中，您可以指定区间范围以及区间的相应费用。您可以点击 + BAND，指定所需数量的区间。

      示例：假设您希望前 1000 次 API 调用按每次调用 2 美元收费，所有后续 API 调用按每次调用 1 美元收费。如需进行配置，请在 Ranges of unit consumption 部分中指定以下两个区间：

      • 在第一行中，输入以下值：
        • 开始：0
        • 结束：1000
        • 费用：2
      • 在第二行中，输入以下值：
        • 开始：1001
        • 结束：无上限单位
        • 费用：1

      在本示例中，如果开发者进行了 1500 次 API 调用，总费用将为 2500 美元 ((1000 * 2) + (500 * 1))。

    如果您启用任何基于用量的费用，则可以预览所选费用类型对总体收益的影响，如预览费率方案中所述。

    如需停用费用，请取消选择收取基于消耗的价格模型。

    如果您已在 DataCapture 政策中配置 perUnitPriceMultiplier 创收变量，则任何类型的基于用量的费用（每单位固定费用或区间）中指定的每个事务费用都会乘以 perUnitPriceMultiplier 的值。

    		 已停用
  7. 点击下一步。
  8. 输入收益分成详细信息，如下所示：
    字段 说明 默认
    收益分成 启用收益分成功能，向开发者合作伙伴分享一定比例的收益。
    1. 选择启用收益分成。
    2. 在开发者收益分成百分比 (%) 字段中输入要分享的收益百分比。

    您可以通过在 DataCapture 政策中配置 revShareGrossPrice 创收变量来获取每个创收事务的分成收益。如需了解详情，请参阅创收变量。

    如果您启用收益分成，则可以预览输入的百分比 (%) 值对各项费用和总费用的影响，如预览费率方案中所述。

    如需停用这项费用，请取消选中启用收益分成。

    		已停用
  9. 点击下一步。
  10. 点击下列选项之一：
    • 保存并发布，以保存并发布费率方案。系统会提示您输入激活日期。如需了解详情，请参阅设置费率方案的激活日期。
    • 保存，以保存费率方案的草稿。
    • 取消，以取消。

经典版 Apigee 界面

如需使用界面创建费率方案，请执行以下操作：

  1. 执行以下任务之一：
    • 在侧边导航栏中依次选择发布 > 创收 > 费率方案，然后点击创建费率方案。
    • 修改 API 产品，然后点击费率方案部分中的 “添加”按钮。
  2. 输入费率方案详细信息，如下所示：
    字段 说明
    费率方案名称 输入费率方案的名称。
    API 产品 从下拉列表中选择要与费率方案关联的 API 产品。
  3. 点击下一步。
  4. 输入结算详细信息，如下所示：
    字段 说明 默认
    结算币种 从下拉列表中选择要用于结算的币种。 美元
    结算周期 从下拉列表中选择客户结算的频率。 每月
    初始化费用

    在费率方案开始日期（即开发者购买 API 产品的日期）向每个开发者收取的一次性费用。

    如果要收取设置费用，请选择收取设置费用，然后在初始化费用字段中输入要收取的金额。

    		 已停用
  5. 点击下一步。
  6. 输入价格详细信息，如下所示。
    字段 说明 默认
    固定周期性费用 启用每单位固定周期性费用：
    1. 选择收取固定周期性费用。
    2. 配置固定周期性费用金额和费用频率。

    我们会在第一个结算周期按比例收取费用。

    启用后，您可以预览固定周期性费用对分项扣款和总扣款的影响，如预览费率方案中所述。

    如需停用这项费用，请取消选择收取固定周期性费用。

    		 已停用
    基于用量的费用。 启用基于消耗的价格：
    1. 选择收取基于消耗的费用。
    2. 选择以下任一选项：
      • 每单位固定费用（对使用的每个单位收取固定费用）
      • 区间（对使用的每个单位收取可变费用，由用量范围决定）

    • 每单位固定费用：对每个获利事务收取固定费用。 在每单位固定费用字段中输入一个值，这是对每个事务收取的费用。

    • 区间：对每个获利事务收取可变费用。事务区间和用量决定一个事务的费用。区间是指 API 用量范围，每个区间收取不同的费用。在 Ranges of unit consumption 部分中，您可以指定区间范围以及区间的相应费用。您可以点击 + BAND，指定所需数量的区间。

      示例：假设您希望前 1000 次 API 调用按每次调用 2 美元收费，所有后续 API 调用按每次调用 1 美元收费。要进行配置，请在 Ranges of unit consumption 部分中指定以下两个区间：

      • 在第一行中，输入以下值：
        • 开始：0
        • 结束：1000
        • 费用：2
      • 在第二行中，输入以下值：
        • 开始：1001
        • 结束：无上限单位
        • 费用：1

      在本示例中，如果开发者进行了 1500 次 API 调用，总费用将为 2500 美元 ((1000 * 2) + (500 * 1))。

    如果您启用任何基于用量的费用，则可以预览所选费用类型对总体收益的影响，如预览费率方案中所述。

    如需停用费用，请取消选择收取基于消耗的价格模型。

    如果您已在 DataCapture 政策中配置 perUnitPriceMultiplier 获利变量，则任何类型的基于用量的费用（每单位固定费用或区间）中指定的每个事务费用都会乘以 perUnitPriceMultiplier 的值。

    		已停用
  7. 点击下一步。
  8. 输入收益分成详细信息，如下所示：
    字段 说明 默认
    收益分成 启用收益分成功能，向开发者合作伙伴分享一定比例的收益。
    1. 选择启用收益分成。
    2. 在开发者收益分成百分比 (%) 字段中输入要分享的收益百分比。

    您可以通过在 DataCapture 政策中配置 revShareGrossPrice 获利变量来获取每个获利事务的分成收益。如需了解详情，请参阅获利变量。

    如果您启用收益分成，则可以预览输入的百分比 (%) 值对各项费用和总费用的影响，如预览费率方案中所述。

    如需停用这项费用，请取消选中启用收益分成。

    		已停用
  9. 点击下一步。
  10. 点击下列选项之一：
    • 保存并发布，以保存并发布费率方案。系统会提示您输入激活日期。如需了解详情，请参阅设置费率方案的激活日期。
    • 保存，以保存费率方案的草稿。
    • 取消，以取消。

Apigee API

如需创建费率方案，请向以下 API 发出 POST 请求：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

通过在请求正文中传递必填字段来配置费率方案，如资源：RatePlans 中所述。

下表汇总了创建草稿和已发布费率方案时的必填字段。

草稿费率方案的必填字段 已发布费率方案的必填字段
  • apiproduct
  • displayName
  • state
  • apiproduct
  • billingPeriod
  • currencyCode
  • displayName
  • startTime
  • state

例如，以下 API 调用会创建与 HelloworldProduct API 产品关联的名为 myrateplan5 的草稿费率方案：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/HelloworldProduct/rateplans" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct":"HelloworldProduct",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "currencyCode":"USD",
    "displayName":"myrateplan5",
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"1"
    }],
    "setupFee":{
       "units":"10",
       "nanos":0
     },
	 "state":"DRAFT"
    }'

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

以下提供了一个响应输出示例：

{
    "name": "4403a3a5-b366-44f0-aa4d-bd54dcfd3239",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan5",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "10"
    },
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 1
        }
    ],
    "state": "DRAFT"
}

如需了解详情，请参阅 Create Rate Plan API

在界面中预览您的费率方案

根据您的价格和收益分成配置，您可以在费率方案页面的费率方案预览部分预览明细费用和计费总额，如下图所示。

输入示例值，查看费率方案预览中的结果

更新 Example consumer data（使用方数据示例）部分中的 API unit consumption（API 单位用量）字段以更改预览中的估算值。分项费用和总费用会根据您输入的值更新。

更新使用方数据示例部分中的以下字段：

  • API 单位用量
    如果在价格下选择了基于用量的费用。
  • 收益
    如果在收益分成下选择了启用收益分成。

为费率方案设置激活和到期时间

设置费率方案的激活时间和到期时间，以表明已发布费率方案何时有效，以及开发者可在其应用中使用的关联 API 产品。

设置激活和到期时间时，请考虑以下事项：

  • API 产品在任何时候都只能有一个费率方案有效。
  • 您可以为同一 API 产品发布多个具有不重叠激活和到期时间的费率方案。
  • 您必须先为费率方案设置激活时间，然后才能发布。
    使用界面发布费率方案时，系统会提示您设置激活时间（如果未设置）。
  • 激活时间必须在到期时间（如设置）之前，并且到期时间必须在激活时间之后。
  • 不需要到期时间。如果未指定，到期时间默认为 Never（费率方案永不过期）。
  • 使用界面设置激活和到期时间时，您只能指定日期，而不能指定时间 (hh:mm:ss:mmm)。激活和到期值的时间分别默认为 12:00:00:000 AM 和 11:59:59:999 PM。

按照以下几个部分的说明设置费率方案的激活时间和到期时间。

Cloud 控制台中的 Apigee

如需使用 Cloud 控制台中的 Apigee 界面设置费率方案的激活时间，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 针对要设置激活时间的费率方案，依次点击 和设置激活。
  3. 从下列选项中选择一项：
    • 无法确定，以取消设置费率方案激活时间（仅适用于草稿费率方案）。
    • 立即，以将费率方案设置为立即生效。
    • 未来日期，以选择费率方案的生效日期。
  4. 点击设置激活。
  5. 发布费率方案（如果尚未发布），以供开发者在应用中使用。

如需使用 Cloud 控制台中的 Apigee 界面设置费率方案的到期时间，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 针对要设置到期时间的费率方案，依次点击 和设置到期时间。
  3. 从下列选项中选择一项：
    • 永不（默认值），以使费率方案永不过期。
    • 立即，以将费率方案设置为立即生效。
    • 未来日期，以选择费率方案的生效日期。
  4. 点击设置到期。

经典版 Apigee 界面

如需使用界面设置费率方案的激活时间，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 针对要设置激活时间的费率方案点击 > 设置激活。
  3. 从下列选项中选择一项：
    • 无法确定，以取消设置费率方案激活时间（仅适用于草稿费率方案）。
    • 立即，以将费率方案设置为立即生效。
    • 未来日期，以选择费率方案的生效日期。
  4. 点击设置激活。
  5. 发布费率方案（如果尚未发布），以供开发者在应用中使用。

如需使用界面设置费率方案的到期时间，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 针对要设置到期时间的费率方案点击 > 设置到期。
  3. 从下列选项中选择一项：
    • 永不，以使费率方案永不过期。
    • 立即，以将费率方案设置为立即生效。
    • 未来日期，以选择费率方案的生效日期。
  4. 点击设置到期。

Apigee API

如需使用 API 设置费率方案的激活或到期时间，请执行以下操作：

  1. 查看要更新的费率方案的详细信息。
  2. 使用响应创建请求正文并更新以下字段：
    • startTime，以设置激活时间
    • endTime，以设置到期时间

  3. 如需使用新配置更新费率方案，请向以下 API 发出 PUT 请求，从而在请求中传递修改后的请求正文：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

例如，以下命令将激活时间设置为 2021 年 4 月 1 日（1617302588000 纪元时间）：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

如需详细了解可以在请求正文中指定的字段，请参阅资源：RatePlans。

以下提供了一个响应输出示例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

如需了解详情，请参阅 Update Rate Plan API

发布费率方案

按照以下部分中的说明发布费率方案。

Cloud 控制台中的 Apigee

如需使用界面发布费率方案，请使用以下方法之一：

  • 创建或更新费率方案时，您可以点击保存并发布以保存并发布费率方案。 系统会提示您设置激活日期。
  • 访问“费率方案”页面，针对要发布的草稿费率方案，依次点击 和发布。

    仅当为草稿费率方案设置激活日期时，才会显示此选项。

经典版 Apigee 界面

如需使用界面发布费率方案，请使用以下方法之一：

  • 创建或更新费率方案时，您可以点击保存并发布以保存并发布费率方案。系统会提示您设置激活日期。
  • 访问“费率方案”页面，然后点击要发布的草稿费率方案的 > 发布。

    仅当为草稿费率方案设置激活日期时，才会显示此选项。

Apigee API

如需使用 API 发布费率方案，请执行以下操作：

  1. 查看要发布的费率方案的详细信息。
  2. 使用响应创建请求正文并更新以下字段：
    • 将 state 设置为 PUBLISHED。
    • 将 startTime 设置为从纪元开始计算的激活时间（以毫秒为单位）。
    • （可选）将 endTime 设置为从纪元开始计算的到期时间（以毫秒为单位），或设置为永不。如果省略，则到期时间默认为 Never。
    • 设置其他要维护的任何字段。

  3. 如需发布费率方案，请向以下 API 发出 PUT 请求，从而在请求中传递修改后的请求正文：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

例如，以下请求将 rateplan1 费率方案的状态更改为 PUBLISHED，并将激活时间设置为 2021 年 4 月 1 日，以从纪元开始计算的毫秒数形式指定：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"PUBLISHED",
    "startTime": 1617302588000
    }'

如需详细了解可以在请求正文中指定的字段，请参阅资源：RatePlans。

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

以下提供了一个响应输出示例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "PUBLISHED",
    "startTime": "1617302588000"
}

如需了解详情，请参阅 Update Rate Plan API

将已发布的费率方案移至草稿状态

按照以下几个部分中的说明，将已发布费率方案移至草稿状态。

Cloud 控制台中的 Apigee

如需使用 Cloud 控制台中的 Apigee 界面将已发布费率方案移至草稿状态，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 依次选择 和移至草稿。

费率方案会更新，且 Status 字段会更改为草稿。

经典版 Apigee 界面

如需使用界面将已发布费率方案移至草稿状态，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 依次选择 > 移至草稿。

费率方案会更新，且 Status 字段会更改为草稿。

Apigee API

如需使用 API 将已发布费率方案移至草稿状态，请执行以下操作：

  1. 查看要移至草稿状态的已发布费率方案的详细信息。
  2. 使用响应创建请求正文并更新以下字段：
    • 将 state 设置为 DRAFT。
    • 设置其他要维护的任何字段。

  3. 如需将已发布费率方案移至草稿状态，请向以下 API 发出 PUT 请求，从而在请求中传递修改后的请求正文：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

例如，下文会将 rateplan1 费率方案的状态更改为 DRAFT：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

如需详细了解可以在请求正文中指定的字段，请参阅资源：RatePlans。

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

以下提供了一个响应输出示例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

如需了解详情，请参阅 Update Rate Plan API

更新费率方案

按照以下几个部分中的说明更新费率方案。另请参阅：

按照以下几个部分中的说明更新费率方案。

Cloud 控制台中的 Apigee

如需使用界面更新费率方案，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 在列表中点击要更新的费率方案的名称。
  3. 根据需要更新费率方案。
  4. 点击下列选项之一：
    • 保存并发布，以保存并发布费率方案。系统会提示您输入激活日期。如需了解详情，请参阅设置费率方案的激活日期。
    • 保存，以保存费率方案的草稿。
    • 取消，以取消您的更新。

经典版 Apigee 界面

如需使用界面更新费率方案，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 在列表中点击要更新的费率方案的名称。
  3. 根据需要更新费率方案。
  4. 点击下列选项之一：
    • 保存并发布，以保存并发布费率方案。系统会提示您输入激活日期。如需了解详情，请参阅设置费率方案的激活日期。
    • 保存，以保存费率方案的草稿。
    • 取消，以取消您的更新。

Apigee API

如需使用 API 更新费率方案，请执行以下操作：

  1. 查看要更新的费率方案的详细信息。
  2. 使用响应创建请求正文，并根据需要更新任何其他配置设置。

  3. 如需更新费率方案，请向以下 API 发出 PUT 请求，从而在请求中传递修改后的请求正文：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

例如，以下命令将基于用量的费用更改为 5；并将收益分成百分比设置为 6.5%，所有其他配置设置都包含在内，以确保它们保持不变：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"5",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"6.5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

如需详细了解可以在请求正文中指定的字段，请参阅资源：RatePlans。

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

以下提供了一个响应输出示例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

如需了解详情，请参阅 Update Rate Plan API

克隆费率方案

克隆费率方案，以便根据现有费率方案创建重复的费率方案。

Cloud 控制台中的 Apigee

如需使用界面克隆费率方案，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 依次选择 和克隆。
  3. 更新费率方案名称和 API 产品字段。
  4. 点击克隆。

费率方案会添加到费率方案列表中。

经典版 Apigee 界面

如需使用界面克隆费率方案，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 依次选择 > 克隆。
  3. 根据需要更新费率方案名称和 API 产品字段。
  4. 点击克隆。

费率方案会添加到费率方案列表中。

Apigee API

如需使用 API 克隆费率方案，请执行以下操作：

  1. 查看要克隆的费率方案的详细信息。
  2. 使用响应创建请求正文并更新以下字段：
    • 移除 name 字段。
    • 根据需要更新任何其他配置设置。
  3. 在请求中传递修改后的请求正文，以创建费率方案。

删除费率方案

费率方案一旦删除便无法恢复。费率方案会立即被删除，并且无法恢复。

按照以下几个部分中的说明删除费率方案。

Cloud 控制台中的 Apigee

如需使用界面删除费率方案，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 针对要删除的费率方案，依次选择 和删除。
  3. 确认要删除的费率方案无误，然后点击删除。

费率方案会从列表中被删除和移除。

经典版 Apigee 界面

如需使用界面删除费率方案，请执行以下操作：

  1. 访问“费率方案”页面。
  2. 依次选择 > 删除，然后选择要删除的费率方案。
  3. 当系统提示您确认删除时，点击删除。

费率方案会从列表中被删除和移除。

Apigee API

如需删除费率方案，请向以下 API 发出 DELETE 请求：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

如需确定要在资源路径中传递的费率方案的名称，请参阅列出组织中的费率方案。

例如，以下命令会删除名为 cc6252c0-c5d0-4aaf-85f2-203ec8fa5707 且显示名为 myrateplan3 的费率方案： 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN

按照获取 OAuth 2.0 访问令牌中的说明，将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项，请参阅使用 curl。如需了解所使用的环境变量，请参阅为 Apigee API 请求设置环境变量。

以下提供了一个响应输出示例：

{
    "name": "93ca14aa-7a48-4384-ae09-c85a0e8a8df8",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

如需了解详情，请参阅 Delete Rate Plans API。