检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
右侧返回结果回显区域打印API调用的Response信息。 开发者可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 父主题: 共享版操作指导(仅存量用户使用)
重置AppSecret 操作场景 AppKey唯一且不可重置,AppSecret支持重置,将AppSecret的值重新改变。重置完成后,原先的AppSecret将失效,绑定此应用的API将无法调用,请更新AppSecret,并重新调用API。 前提条件 已创建应用。 操作步骤 进入共享版控制台。
删除访问控制策略 操作场景 当已创建的访问控制策略不再需要时,可以将此访问控制策略删除。 前提条件 已创建访问控制策略。 操作步骤 进入共享版控制台。 选择“开放API > 访问控制”,进入访问控制策略列表页面。 通过以下任意一种方式,弹出“删除访问控制策略”对话框。 在待删除的访问控制策略所在行,单击“删除”。
删除应用 操作场景 已创建的应用不再提供服务,可以将应用删除。 从云商店购买的API生成的应用,不支持删除。 前提条件 已创建应用。 操作步骤 进入共享版控制台。 单击“调用API > 应用管理”,进入到应用管理信息页面。 通过以下任意一种方式,进入对话框。 在待删除的应用所在行,单击“删除”。
查看监控指标 操作场景 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API分组和分组内的API。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
发布API 操作场景 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。
删除VPC通道 操作场景 已创建的VPC通道不再需要时,可以直接删除。 如果API已经使用VPC通道,且API已发布到环境,此时无法删除此VPC通道。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 通过以下任意一种方法,弹出对话框。
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
删除特殊应用或租户 操作场景 在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待删除特
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息。
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
API网关支持专享版和共享版(存量用户)功能。共享版功能已下线,当前仅存量用户可以使用,共享版功能操作指导请参考共享版操作指导(仅存量用户使用),其余为专享版功能操作指导章节。 使用流程 使用API网关进行API的托管流程如下图所示。 图1 业务使用流程 创建用户并授权使用APIG 通过I
删除分组 操作场景 API分组在创建后,如需对创建的数据进行删除,可以删除此分组。 如果API分组下存在API,API分组无法被删除。 前提条件 已创建分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“删除分组”对话框。
绑定域名 操作场景 开放API前,您需要为API分组绑定一个或多个独立域名,API网关通过独立域名定位到此分组。 共享版中,不同分组下不能绑定相同的独立域名。 在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一
通过CCE工作负载导入API API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)的工作负载,将工作负载作为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE
deleteApp 更新应用 App updateApp 重置签名密钥 App resetAppSecret 客户端绑定API AppAuth grantAuth 客户端解绑API AppAuth relieveAuth 创建签名密钥 Signature createSignature
与“时长”配合使用,表示单位时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限,仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。