检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍API分组的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
创建API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。
对象模型 本节介绍环境变量的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
新建变量 功能介绍 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。
对象模型 本节介绍流控策略与API的绑定关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数
绑定域名 功能介绍 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
义。如果“扩展定义”中未包含需要的定义，请提前在API网关中创建。 导入API前，请确保API分组和API的配额满足需求。 操作步骤 进入共享版控制台。 单击“开放API > API管理”，进入到API管理信息页面。 单击“导入API”，进入“导入API”界面。 选择如表1所示参数。
仅在API为APP认证时，才支持授权给应用。 前提条件 已创建API分组和分组内的API。 （可选）已创建环境。 已创建应用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”，进入到API管理信息页面。 通过以下任意一种方法，进入“授权应用”页面。 在待授权的API所在行，单击“更多
用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版：SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） avg_latency
自定义认证 创建自定义认证 删除自定义认证 父主题： 共享版操作指导（仅存量用户使用）
删除流控策略 操作场景 当已创建的流控策略不再提供服务时，可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”，进入到流量控制信息页面。 通过以下任意一种方式，弹出“删除流控策略”对话框。 在待删除的流控策略所在行，单击“删除”。
绑定域名 操作场景 开放API前，您需要为API分组绑定一个或多个独立域名，API网关通过独立域名定位到此分组。 共享版中，不同分组下不能绑定相同的独立域名。 在绑定域名前，您需要理解以下2个概念： 子域名：API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名唯一
已创建的VPC通道不再需要时，可以直接删除。 如果API已经使用VPC通道，且API已发布到环境，此时无法删除此VPC通道。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”，进入到VPC通道列表页面。 通过以下任意一种方法，弹出对话框。 在待删除的VPC通道所在行，单击“删除”。
图1 API网关服务开放API 开放API的业务使用流程如下图所示。 图2 API网关服务开放API基本流程 创建实例 共享版无需购买实例，可直接进入共享版。 创建API分组 每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 绑定域名 在开放API前，
自动生成App Code 功能介绍 创建App Code时，可以不指定具体值，由后台自动生成随机字符串填充。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{app_id}/app-codes
查看变量详情 功能介绍 查看指定的环境变量的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2
编码。 type 否 Integer 流控策略的类型，取值如下： 1：独享，表示绑定到流控策略的单个API流控时间内能够被调用多少次 2：共享，表示绑定到流控策略的所有API流控时间内能够被调用多少次 enable_adaptive_control 否 String 是否开启动态流控：
绑定流控策略 功能介绍 将流控策略应用于API，则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后，后续的访问将会被拒绝，从而能够较好的保护后端API免受异常流量的冲击，保障服务的稳定运行。 为指定的API绑定流控策略，绑定时，需要指定在哪个环境上生效。
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数，也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置，例如设置所有APP每分钟的访问次数为500次，但想设置APP1每分钟的访问次数为800次，可以通
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
