要设置 API 键,请执行以下操作:
将 API 方法配置为需要 API 键。
为区域的 API 创建或导入 API 键。
在设置 API 键之前,您必须先创建一个 API 并将其部署到某个阶段。创建 API 密钥值后,无法更改此值。
要使用 REST API 调用创建和部署 API,请分别参阅 restapi:create
和 deployment:create
。
注意
有关可考虑的最佳实践,请参阅 API 密钥和使用计划的最佳实践。
要求方法使用 API
要让某个方法使用 API,请执行以下操作之一:
-
调用
method:put
以创建方法。在请求负载中将apiKeyRequired
设置为true
。 -
调用
method:update
将apiKeyRequired
设置为true
。
创建或导入 API 密钥
要创建或导入 API 密钥,请执行以下操作之一:
-
调用
apikey:create
以创建 API 密钥。 -
调用
apikey:import
以从某个文件导入 API 密钥。有关文件格式的信息,请参阅 API Gateway API 密钥文件格式。
您无法更改新 API 密钥的值。要了解如何配置使用计划,请参阅使用 API Gateway CLI 和 REST API 创建、配置和测试使用计划。