检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。
约束与限制 API分组 一个API只能属于一个API分组。 SSL证书 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA加密算法。 域名 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到非RELEASE环境无法访问时,添加x-stage请求消息头后即可访问。 例如: r.Header.Add("x-stage", "RELEASE") 您也可以参考快速开放并调用API章节中的示例。
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
如果后端服务地址中需要携带环境变量,则使用“#变量名#”的形式将环境变量添加到后端服务地址中,如#ipaddress#。支持添加多个环境变量,如#ipaddress##test#。 说明: IP地址/域名可以是公网IP(支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址)/公网域名,前提需
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
ASE环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage: Develop”。 创建环境变量 进入API网关控制台页面。
配置APIG专享版与客户端间的单向认证或双向认证 应用场景 API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证。
请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时
GET /v1.0/apigw/signs[?page_size, page_no, id, name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name。 请求消息 表2 参数说明 名称 是否必选 类型 说明 id 否 String
s/{instance_id}/signs[?page_size, page_no, id, name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name。 请求消息 表2 参数说明 名称 是否必选 类型 说明 project_id
调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。 调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
API网关主要涉及以下几个开发场景: API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 使用APP认证(签名认证)调用API:API调用者通过API网关提供Key、Secret和SDK,对API请求进行签名认证。
时,需要添加SSL证书。 单击“添加SSL证书”,弹出“添加SSL证书”对话框。 根据已获取SSL证书,输入证书名称、证书内容和密钥,单击“确定”,完成SSL证书的添加。 图1 添加SSL证书 SSL证书目前仅支持pem类型,如需添加其它证书类型,可转换成pem类型后添加。 如果
请求方法 URI GET /v1.0/apigw/envs[?page_no, page_size,name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:name、page_size、page_no。 表2 参数说明 名称 是否必选 类型
stances/{instance_id}/envs[?page_no, page_size,name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:name、page_size、page_no。 表2 参数说明 名称 是否必选 类型
0/apigw/config/project[?page_size, page_no, config_id, config_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:config_name、config_id、page_size、page_no。 URI中的参数说明如下所示。
-channels[?page_size, page_no, id, name, vpc_type] o 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、vpc_type、page_size、page_no。 表2 参数说明
0/apigw/vpc-channels[?page_size, page_no, id, name, vpc_type] o 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、vpc_type、page_size、page_no。 表2 参数说明
nstance_id}/throttles[?page_size, page_no, id, name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、page_size、page_no。 请求消息 表2 参数说明 名称