检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询API分组概况 功能介绍 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/resources/outline/groups
是否支持移动应用调用API? API支持被移动应用调用。 使用APP认证时,将移动应用的AppKey和AppSecrect替换SDK中的AppKey和AppSecrect进行APP签名。 父主题: 调用API
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances
对象模型 API需要绑定ACL策略,ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型,如表1所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。
API的策略后端有多个时,怎么匹配和执行API请求? 当您的API配置了多个策略后端,API网关会按顺序进行匹配,匹配到其中一个立即执行API请求转发,不会进行后续的匹配。 当策略后端都没有匹配成功,则按照默认后端执行API请求的转发。 父主题: 调用API
使用限制 专享版API(V1)的接口,只有上海二,广州,北京四,北京一,墨西哥和圣保罗局点支持注册,且仅用于存量用户使用。 请新用户在使用API时参考专享版API(V2)接口文档。 父主题: 专享版API(V1)(待下线)
None 操作指导 API网关 APIG 介绍开放API的操作流程 04:34 开放API API网关 APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用API(简易认证)
查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?page_size=10&page_no=5
API签名认证的内容是否包括Body体? 包括。除了几个必选的请求头部参数,Body体也是签名要素之一。例如有一个使用POST方法上传文件的API,那么在签名过程中,会取这个文件的hash值,参与生成签名信息。 关于签名的详细指导,可参考:签名认证算法详解。 父主题: API认证
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号,可通过查询APP列表获取。
删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号
操作类型 是否必选 id String 授权关系的ID R - app_id String APP的编号 CR 是 front_api_id String api的编号 CR 是 env_id String 环境编号(发布环境) CR 是 create_time Timestamp 授权时间
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id}
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 环境的ID,可通过查询环境信息获取该ID
对象模型 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 系统配置对象模型
使用iOS系统时,如何使用APP认证调用API? 目前API网关为APP认证提供了Java、Python、C、PHP、Go等多种语言的SDK与demo。 当您使用iOS系统(Objective-C语言)或者其他未包含在内的语言时,请参考APP认证工作原理的指导进行APP认证。 父主题: 调用API
APIG是否支持WebSocket数据传输? API网关支持WebSocket数据传输。 在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 父主题: 调用API
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/acls 请求消息 表2 参数说明 参数 类型 说明 acl_name String ACL策略名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3
对象模型 本节介绍签名密钥的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥模型 参数 类型 说明 操作类型 是否必选