检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看流控策略未绑定的API列表 功能介绍 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/a
使用场景 API网关主要涉及以下几个开发场景: API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 使用APP认证(签名认证)调用API:API调用者通过API网关提供Key、Secret和SDK,对API请求进行签名认证。
查看ACL策略未绑定的API列表 功能介绍 查看ACL策略未绑定的API列表,需要API已发布。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/in
查看签名密钥未绑定的API列表 功能介绍 查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。 URI HTTP/HTTPS请求方法以及URI如表3-73所示。 表1 HTTP/HTTPS请求方法以及 请求方法 URI GET /v1/{proj
新增网关响应 操作场景 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
“发布”。 如果需要批量发布API,则勾选待发布的API,单击“发布”。最多同时发布1000个API。 选择API需要发布到的环境,并填写发布说明。 图1 发布API 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。
单击“API名称”,进入API详情页面。在右上角单击“下线”,弹出“下线API”对话框。 如果需要批量下线API,则勾选待下线的API,单击“下线”。最多同时下线1000个API。 选择API需要下线的环境,单击“确定”,完成API下线。 后续操作 您将API下线后,可以通过删除API,释放此API所占用的资源。
户端认证即双向认证;反之,开启单向认证。 单向认证:客户端与服务端连接时,客户端需要校验服务端SSl证书合法性。 双向认证:客户端与服务端连接时,除了客户端需要校验服务端SSl证书合法性,服务端也需要校验客户端SSl证书合法性。 父主题: 配置APIG专享版与客户端间的单向认证或双向认证
查看ACL策略未绑定的API列表 功能介绍 查看ACL策略未绑定的API列表,需要API已发布。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acl-bindings/unbinded-apis[
查看签名密钥未绑定的API列表 功能介绍 查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。 URI HTTP/HTTPS请求方法以及URI如表3-73所示。 表1 HTTP/HTTPS请求方法以及 请求方法 URI GET /v1.0/api
查看流控策略未绑定的API列表 功能介绍 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{pr
Q:APP认证的API,是否需要自己创建应用(凭据)? 是,需要自行创建应用(凭据),并绑定API。创建完成应用(凭据)后,系统自动生成AppKey和AppSecret,将AppKey和AppSecret给第三方,就可以直接调用此API了。 Q:APP认证的API,第三方怎么调用? 您需要把AppK
本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时,请根据需要下载SDK包和文档,参考文档完成API的调用。 操作步骤 进入共享版控制台,单击。 单击“帮助中心”,进入到帮助中心页面。 单击“SDK使用指引”页签。
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。 简单请求的跨域访问 如果是创建新的API,在定义API请求时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 图2 支持跨域 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个
器,发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件: 请求方法是HEAD,GET,或者POST。 HTTP的头信息不超出以下范围: Accept Accept-Language
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
在“网关响应”区域,您可以新增或编辑网关响应。 如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
推送的日志中,需要携带的API响应信息。 日志包含响应头域信息:勾选后,需填写日志中要携带的响应Header参数。多个字段间使用英文逗号(,)分隔,支持使用*进行通配设置。 日志包含响应Body体信息:勾选后,日志中会携带响应Body体信息。 自定义认证配置 推送的日志中,需要携带的自定义认证信息。