编辑草稿产品
初始创建草稿产品后,可继续配置该产品,或者可也稍后进行配置更改。
关于此任务
您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。
在初始创建产品期间,产品创建向导会指导您输入最低配置设置,然后提供编辑产品按钮。 您可以选择立即指定其他配置,或者返回至产品以便稍后对其进行编辑。 本主题描述了如何在上述任意情况下指定其他配置。
过程
要编辑草稿产品,请完成以下步骤:
- 通过下列其中一种方式访问 " 产品设置 " 页面:
- 完成产品初始创建后,请单击编辑产品。
- 在导航窗格中,单击 开发,然后选择 产品 选项卡。
- 单击要编辑的产品的标题。
- 在“产品设置”页面上,可进行以下配置更改:
- 在 信息 部分中,更改 标题, 版本或 摘要。
- 使用 联系人, 服务条款和 许可证 部分可根据需要输入相应的详细信息。
- 更改网关类型。 更多信息,请参阅 "API Connect网关类型和为产品指定网关类型。
- 单击保存以保存更改。
- 可选: 指定要在 Developer Portal中随产品一起显示的产品元数据:
- 单击 源 选项卡以查看产品的 OpenAPI 源。
- 将定制属性
x-name: value添加到info部分中。 例如:
其中info: version: 1.0.0 title: Multi Plans name: multi-plans x-customarg: This is the custom value ...customarg是定制元数据的名称,This is the custom value是信息内容。 - 单击保存。在 Developer Portal中发布产品时,将随产品一起显示定制元数据。 例如:

- 单击“可视性”,然后根据需要进行以下更改:
- 在可视性部分中,指定允许查看产品的用户。 可以选择公共来使产品对所有用户均可见,选择已认证来使产品可供已成功认证的用户使用,或选择定制以指定您希望产品对其可见的使用者组织和使用者组织组。如果选择 定制,请完成以下步骤:
- 选择要控制其可视性的目录。
- 使用 搜索组织和组 字段在所选目录中搜索您希望产品对其可视的使用者组织和使用者组织组。 如有需要,您可以输入目前不存在但将来会添加的消费者组织或组织组的名称。 之后,使用相同的名称创建它。 有关如何创建和管理使用者组织和使用者组织组的信息,请参阅 管理使用者组织。
- 在 可预订性 部分中,指定可以预订产品中的计划的用户。 您可以选择 已认证 以使已成功认证的用户可预订产品中的计划,或者选择 定制 以指定可预订产品中的计划的使用者组织和使用者组织组。如果选择 定制,请完成以下步骤:
- 选择要控制其可预订性的目录。
- 使用 搜索组织和组 字段在所选目录中搜索要预订产品的使用者组织和使用者组织组。 如有需要,您可以输入目前不存在但将来会添加的消费者组织或组织组的名称。 之后,使用相同的名称创建它。 有关如何创建和管理使用者组织和使用者组织组的信息,请参阅 管理使用者组织。
注:- 如果选择定制可视性或可预订性,那么在使用者组织和使用者组织组的选择列表中仅显示 10 个搜索结果。 如果需要,请输入更具体的搜索字符串以优化搜索。
- 虽然显示每个组织或组的标题,后跟括号中的名称,但在所选组织和组的表中仅显示名称
- 单击保存以保存更改。
- 在可视性部分中,指定允许查看产品的用户。 可以选择公共来使产品对所有用户均可见,选择已认证来使产品可供已成功认证的用户使用,或选择定制以指定您希望产品对其可见的使用者组织和使用者组织组。
- 要指定要包含在产品中的 API ,请单击 API,然后完成以下步骤:
- 单击 编辑。这样会列示所有草稿 API。
- 选择要包含的 API。 对于暂存或发布,您可以只包含网关类型与产品 的网关类型相匹配的 API,或已禁用强制选项的 API。 强制执行 选项被禁用的应用程序接口不在 API Connect 网关上管理. 如果选择网关类型与产品网关类型不匹配的不兼容 API,那么将显示警告消息,并且在清除不兼容的选项之前无法保存更改。 有关网关类型的更多信息,请参阅 API Connect 网关类型、 为产品指定网关类型和为 API 定义指定网关类型。
- 完成后单击 保存 。这样会列示选定的 API。
注:要使 API 对应用程序开发者可用,必须将其包含在计划中。 - 单击 编辑。
- 可选: 向产品添加计费集成。 单击计划,在“计费集成”部分中,选择要应用于产品的计费集成资源。在“计划”部分中,您可以编辑“缺省计划”以添加定价信息,或者创建具有定价信息的新计划。 有关计费集成的更多信息,请参阅 对产品进行货币化。
- 可选: 向产品添加一个或多个计划,或者修改现有计划。 请注意,将自动为您创建缺省计划,速率限制为每小时 100 次 API 调用。
- 单击 计划。
- 要添加新计划,请单击 添加。 要修改现有计划,请单击所需计划旁边的选项图标 "
,然后单击 "编辑"。 - 指定计划的 标题 以及 (可选) 描述。 将自动输入 名称 。注: 名称 字段中的值是用于在 developer toolkit CLI 命令中标识计划的单个字符串。 标题 用于显示。
- 指定计划是否需要预订核准。 如果需要对开发者的预订进行核准,请选中核准复选框;否则请确保清除该复选框。注:要查看订阅任务历史记录,请完成以下步骤:
- 在 API 管理器用户界面的导航窗格中,单击 "管理",然后选择要处理的目录。
- 单击任务选项卡。
- 从导航窗格中单击 "审批历史记录"。
- 在 套餐定价 部分中,可以通过完成以下步骤来添加定价信息:
- 对于 套餐定价,将切换开关更改为 开启 。 这样会显示“计划定价”定义部分。
- 如果要在计划中添加任何免费试用天数,请选择包含免费试用天数,然后输入订户可以免费使用计划的试用天数,计费周期在经过此天数之后开始。
- 选择计费流程使用的货币。
- 输入对订户计费的每月价格。 如果所选货币支持小数单位,请输入包括任何小数单位的价格,例如,美分。
- 在 " 计划速率限制 " 部分中,可以修改速率限制,然后单击 添加 以添加更多速率限制。 您可以按秒、分钟、小时、天和周时间间隔设置多个速率限制。 要删除费率限制,请单击相应的删除图标 '
. - 在 计划突发流量限制 部分中,可以修改突发流量限制,然后单击 添加 以添加更多突发流量限制。 突发流量限制可用于防止出现可能会损坏基础架构的使用峰值。 可以按秒和分钟时间间隔设置多个突发流量限制。 要删除突发限制,请单击相应的删除图标 '
.速率和突发流量限制一起用于管理在计划下包含的 API 的网络流量。 一个计划可具有多个速率和突发流量限制,但是建议仅为每个时间间隔分配一组限制。 调整速率和突发流量限制,以允许最大流量,而不会使网络过载。 速率限制设置在某个时间间隔内访问网络上 API 的可持续进行的最大流量(例如,一天)。 突发流量限制设置一个时间间隔(每秒或每分钟)内网络的最大短期流量。
突发流量限制允许增加流量的短期脉冲串。 当超出突发流量限制时,将拒绝所有后续 API 调用,直到下一个突发流量限制时间间隔开始为止。 突发流量限制计数器在下一个时间间隔开始时复位为零,这允许再次接受 API 调用。 这些 API 调用计入速率限制计数器,但重置突发流量限制计数器不会影响速率限制计数器。
速率限制是在某个时间间隔内允许的 API 调用数,例如,每天 1000 个调用。 当超过速率限制并且启用了硬限制时,将拒绝所有后续 API 调用。 速率限制计数器在下一个速率限制时间间隔开始时复位为零,这允许再次接受 API 调用。 如果禁用了硬限制,那么仍将接受所有后续 API 调用,并记录一条消息,表明已超出速率限制。 这称为“软限制”。
硬限制仅影响速率限制,如以下场景所示:
- 场景 A
表 1. 启用硬限制 硬限制 突发流量限制 速率限制 打开 100 个调用/分钟 1000 个调用/天 - 如果用户在一分钟内调用 100 次 API,那么将达到突发流量限制。 将拒绝同一分钟内的第 101 个调用(以及任何后续调用)。 一旦该分钟结束,突发流量限制计数器就会复位。 所有 API 调用均遵照每天 1000 次调用的速率限制。 重置突发流量限制计数器不会影响速率限制计数器。
- 如果用户每分钟调用 99 次 API,那么他们将不会达到突发流量限制。 他们最终将达到每天 1000 次调用的速率限制,而第 1001 次调用将被拒绝,直到同一天的速率限制时间间隔结束为止。 在由于超出每日速率限制而拒绝 API 调用的时间段内,因为调用已被拒绝,将不会激活突发流量限制。
- 每个使用者都应用了突发流量限制和速率限制。
- 场景 B
表 2. 禁用硬限制 硬限制 突发流量限制 速率限制 关闭 100 个调用/分钟 1000 个调用/天 - 与场景 A 一样,如果用户在一分钟内调用 API 100 次,那么在同一分钟内的第 101 次调用将被拒绝,直至该分钟结束并且计数器复位为止。 这些调用还会计入每天 1000 个调用的速率限制。
- 如果用户每分钟调用 99 次 API,那么他们将不会达到突发流量限制。 他们最终将达到每天 1000 次调用的速率限制,并将接受第 1001 次调用(因为无硬限制)。 将为每个后续调用记录一条消息,直到时间间隔(一天)结束且计数器复位为止。 在这一天的剩余时间内,仍将强制执行突发流量限制,并且一旦在任意给定的分钟内调用次数超过每分钟 100 个调用,就将拒绝调用。
- 每个使用者都应用了突发流量限制和速率限制。注: 取消选中 硬限制 时, 速率限制 被视为 "软限制"。 如果使用软限制,那么在达到速率限制后,不会拒绝调用。 而是会在日志文件中记录一条消息。 使用软限制时,超出突发流量限制后仍会拒绝 API 调用。
- 要在计划中包含步骤 5中包含的所有 API ,请在 " 计划 API " 部分中选择 与产品相同 。
- 在 GraphQL 速率限制 部分中,可以配置将应用于添加到产品的任何 GraphQL 代理 API 的速率限制。以下速率限制可用:
- graphql-field-cost
- 将限制应用于对此计划中 GraphQL 代理 API 进行的 GraphQL 查询调用的总计算字段成本。
- graphql-design-request
- 将限制应用于对此计划中 GraphQL 代理 API 进行的以下任何类型的调用的总数:
- 已发送到
graphql/cost端点的请求,用于检索 GraphQL 查询的成本。 有关详细信息,请参阅为GraphQLAPI 启用成本端点。 - 发送到
/graphql端点的标准自省请求。 如需了解更多信息,请参阅支持GraphQLAPI 的自省。 - 发送到
/graphql端点的 GraphiQL 编辑器的 HTML Web 浏览器请求。 更多信息,请参见 "Enabling the GraphiQL editor for a GraphQL API。
- 已发送到
- graphql-input-type-cost
- 将限制应用于对此计划中 GraphQL 代理 API 进行的 GraphQL 查询调用的总计算输入类型成本。
- graphql-type-cost
- 将限制应用于对此计划中 GraphQL 代理 API 进行的 GraphQL 查询调用的总计算类型成本。
计算的成本取决于应用于 GraphQL 模式中的类型和字段的加权因子。 有关GraphQL代理 API 以及配置类型和字段权重的详细信息,请参阅创建GraphQL代理 API和使用GraphQL模式编辑器。
- 要定义一个或多个组合件突发流量限制或组合件计数限制,请在 组合件突发流量限制 或 组合件计数限制 部分中单击相应的 添加 。 对于突发流量限制,指定在指定的时间段内允许的最大调用数,对于计数限制,指定最大调用限制。 您提供的名称用于 API 程序集中的速率限制策略,使该策略能够定义要应用的突发或计数限制;有关更多信息,请参阅速率限制。
- 要选择要包含在计划中的 API ,请在 计划 API 部分中选择 定制计划 API 列表 ,然后单击 编辑。 这样会打开编辑计划 API 窗口。 可供选择的 API 是在步骤 5中包含在产品中的 API。 使用复选框指定所需的 API,然后在完成时单击保存。
- 要选择要包含在计划中的特定 API 操作,请单击所需 API 旁的选项图标 "
,然后单击 "编辑操作列表。 这样会打开选择要包含的操作窗口。 使用复选框指定所需的操作,然后在完成时单击保存。 - 要从 "计划 "中删除应用程序接口,请单击 "计划应用程序接口部分所需应用程序接口旁边的选项图标 "
,然后单击 "移除。 - 对于计划中的任何 GraphQL API,如果要阻止此计划的订户使用特定类型或字段,请完成以下步骤:
- 在 "计划应用程序接口部分点击选项图标 "
和所需的 "GraphQLAPI,然后点击 "编辑显示/隐藏设置。 - 要防止使用某个 GraphQL 类型,请取消选中该类型旁边的复选框。
- 要防止使用某个类型的字段,请展开该类型,然后取消选中该字段旁边的复选框。
- 完成后,单击 下一步。 这样会打开摘要窗口。 如果允许该操作,那么系统会列示也将隐藏的任何相关元素;例如,如果隐藏某个类型,并且该类型被引用为其他类型字段的数据类型,那么该字段也被隐藏。 如果不允许该操作,那么将显示说明。
- 如果允许该操作,请单击完成以应用更改。 如果不允许该操作,请单击取消以关闭窗口或单击返回并修改设置。
您可以使用编辑显示/隐藏设置选项来更改现有设置;您可以隐藏其他类型或字段,也可以显示先前隐藏的类型或字段。
- 在 "计划应用程序接口部分点击选项图标 "
- 要为特定 API 操作定义费率限制,请在 "计划 API "部分选择 "覆盖个别操作的计划费率限制";有关详细信息,请参阅为 API 操作定义费率限制
- 单击保存以保存更改。
- 可选: 指定要在 Developer Portal中随计划一起显示的计划元数据:
- 单击 源 选项卡以查看计划的 OpenAPI 源。
- 将定制属性
x-name: value添加到相应的plan部分。 例如:
其中... plans: default-plan: title: Default Plan description: Default Plan x-customarg: This is the custom value rate-limits: default: value: 100/1hour hard-limit: false minute: value: 20/1minute hard-limit: false apis: petstore-header-clientid1.0.0: {} ...customarg是定制元数据的名称,This is the custom value是信息内容。 - 单击保存。在 Developer Portal中发布计划时,将随计划一起显示定制元数据。 例如:

- 可选: 单击 类别,然后定义要将产品组织到的任何类别。 单击 保存 以保存任何更新。通过将产品组织到类别中,可以在 Developer Portal中提供产品的分层显示。 有关更多信息,请参阅将产品分类。