检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过以下任意一种方法,进入API调试页面。 在待调试的API所在行,单击“更多 > 调试”。 单击“API名称”,进入API详情页面。在右上角单击“调试”。 图1 调试界面 左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。 表1 调试API 参数名称
否 String 请求消息体,最长2097152字节 mode 是 String 调试模式 DEVELOPER 调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。
method 是 String API的请求方法 mode 是 String 调试模式 DEVELOPER 调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。
否 String 请求消息体,最长2097152字节 mode 是 String 调试模式 DEVELOPER 调试尚未发布的API定义 MARKET 调试云商店已购买的API CONSUMER 调试指定运行环境下的API定义 说明: DEVELOPER模式,接口调用者必须是API拥有者。
调试API的时候,如何指定环境? 不能指定。 API网关控制台提供的调试功能,用的是特定的debug环境,调试完成后需先发布到对应环境,之后可使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
设置调试域名是否可以访问 功能介绍 禁用或启用API分组绑定的调试域名 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/sl-domain-access-settings
调用APIG开放的API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 如果在API网关控制台“API管理 > API策略 > SSL证书管理”界
企业账号是否有调试域名每天最多可以访问1000次的限制? 有。 每个子域名(调试域名)每天最多可以访问1000次的限制同样适用于企业账号。 有关子域名(调试域名)的详细指导,请参考绑定域名。 父主题: API策略
调用API失败的可能原因 网络问题 调用API失败的场景分为三种:同一VPC内调用失败、不同VPC之间调用失败、公网调用失败。 VPC内调用API失败时,请检查域名是否和API自动分配的域名一致,如果域名错误,会导致调用API失败。 不同VPC之间调用API失败时,请检查两个VPC的网络是否互通。
Ingress和Gateway API的功能,不仅大幅提升了性能,还简化了架构,降低了部署和运维成本。 便捷调试工具 API网关提供页面调试工具,您可以使用该工具添加HTTP头部参数与body体参数,对API进行调试,简化API开发,降低API的开发维护成本。 版本管理 API可以发布到不同的环境,如
调用API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。
您也可以使用系统分配的调试域名(子域名)访问API分组内的API,该调试域名唯一且不可修改,每天最多可以访问1000次,仅适用于内部测试使用。 同一实例下的不同分组不能绑定相同的独立域名。 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。
选择API响应的HTTP状态码,此处默认“200”。 Mock返回结果 用于调试验证,返回预期结果,此处填写“success”。 单击“完成”,完成API的创建。 调试API。 在“API运行”页面的右侧单击“调试”。 在URL右侧单击“调试”,下方为API发送的请求信息和API请求调用后的返回结果回显。
负载通道:填写已创建的负载通道。 路径:后端服务的路径。 定义返回结果后,单击“完成”。 调试API。 在“API运行”页签中,单击“调试”,进入调试页面。再次单击“调试”,响应结果中返回状态码“200”,表示调试成功,执行下一步。否则,请参考错误码章节处理。 发布API。 在“API运行”
使用WAF对APIG进行安全防护 企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 图1 后端服务器访问原理 方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 推荐原因:API分组通过域名方式对外提供服务,具备更强的可扩展性。
客服。 注意事项 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。 您需要确保当前实例与CCE集群所属同一个VPC中,或通过其他方式保证两者网络可达,否则导入后调用API会出现失败场景。 选择VPC网络模型的CCE集群时,您需要在实例详情界面的路由配置中添加CCE
return json.dumps(resp) 配置测试事件并调试代码,然后部署。 在下拉框中选择“配置测试事件”并配置。 测试事件的参数值与环境变量中的参数值保持一致。 创建测试事件完成后,单击“测试”调试代码。 单击“部署”。 进入API网关控制台,在左侧导航栏选择“API管理
下游服务(服务端和客户端)需要酌情调整网络安全策略,保证网络可达。如果下游存在跨VPC调用的场景时,需要通过VPC终端节点对接到APIG专享版的VPC终端节点服务上,以保证网络可达。具体操作详见实施步骤。 调试域名的变化 原共享版的分组调试域名{group-id}.apig.{region-id}
0支持 购买API网关 修改子网网络信息 本小节指导您顺利购买专享版实例,实例创建完成后,才能创建API并对外提供服务。如果您对服务的性能需求不大,可使用共享版API网关,直接创建与管理API,而无需单独购买专享版实例。 删除子网 当无需使用子网、需要释放网络资源时,可删除子网。 支持区域: