检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
创建APIG实例 本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。 用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。 导入API设计文件
成鉴权。关于使用APP认证的方法,具体请参考《API网关开发指南》。 从云商店购买的API,系统自动创建一个应用,无需单独创建应用。 使用无认证/华为IAM认证的API,无需创建应用。 应用配额包括您自行创建的应用和在云商店购买API生成的应用。 创建应用 进入共享版控制台。 单击“调用API
单击“创建分组”,弹出“创建分组”对话框。填写如表1所示信息。 表1 分组信息表 信息项 描述 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 完成分组信息填写后,单击“确定”,创建API分组。 创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 调用方法 请参见如何调用API。 URI POST /v2/{
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
创建自定义认证 功能介绍 创建自定义认证 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers 表1 路径参数 参数 是否必选 参数类型 描述 project_id
同一个环境中一个API只能被一个访问控制策略绑定,一个访问控制策略可以绑定多个API。 创建访问控制策略 进入共享版控制台。 选择“开放API > 访问控制”,进入访问控制策略列表页面。 单击“创建访问控制策略”,弹出“创建访问控制策略”对话框。 输入表1如所示信息。 表1 访问控制策略信息 信息项
给用户授权API网关服务权限流程 创建用户组并授权 在IAM控制台创建用户组,并授予API网关服务的权限“APIG Administrator”或“APIG FullAccess”。 创建用户并加入用户组 在IAM控制台创建用户,并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台,验证API网关服务的权限。
x7、铂金版 x8 vpc_id 是 String 虚拟私有云ID。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id
无法创建API是什么原因? API免费创建。如果被限制操作,可能原因为用户欠费,请及时充值。 计费相关的详细指导,请参考计费说明。 父主题: 开放API
通过自定义认证调用API 前提条件 已在函数工作流服务中完成函数创建。 用户还需具备FunctionGraph Administrator角色权限。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,单击“创建自定义认证”,弹出“创建自定义认证”对话框。 填写如表1所示信息。 表1
创建包周期规格变更订单 功能介绍 创建包周期规格变更订单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/prepay-resize 表1 路径参数 参数 是否必选 参数类型 描述
分等。具体操作请参考标签与注解。 在CCE控制台通过“创建负载”方式创建工作负载时,配置Pod标签。进入创建工作负载页面,在“高级配置 > 标签与注释 > Pod标签”区域配置即可。 在CCE控制台通过“YAML创建”方式创建工作负载时,配置Pod标签。例如“app=service01”
x7、铂金版 x8 vpc_id 是 String 虚拟私有云ID。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id
orization头中签名是否一致来校验API的合法性。 图1 签名密钥流程 创建签名密钥 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 单击“创建密钥”,弹出“创建密钥”对话框。 填写如表1所示信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。
发布APIG创建的API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 约束与限制 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。
创建分组自定义响应 功能介绍 新增分组下自定义响应 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses 表1
前提条件 已创建API分组。 创建环境 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 单击“创建环境”,弹出“创建环境”对话框。填写如表1所示信息。 图2 创建环境 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。