检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG是否支持WebSocket数据传输? API网关支持WebSocket数据传输。 在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 父主题: 调用API
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1.0/apigw/openapi?group_id={0}&mode={1}
证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。 访问控制 流量控制:APIG通过凭据、API、IP、用户等多维度的流控策略保护系统。
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 该接口供FunctionGraph服务使用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1/{project_id}/apigw
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 该接口供FunctionGraph服务使用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,
在“API运行”页面单击“调试”,调试已创建的API。 响应结果中显示“200 OK”,表示API调用成功,并且返回值中有“策略后端”字样,表示设置的策略后端的匹配条件成功匹配到前端自定义认证函数返回体中的context字段中的键值对,API调用策略后端成功。否则,请参考错误码章节处理。 在“API运行”页面,单击“编辑”,进入API设置页面。
API列表”,单击API名称进入API详情,在“API运行”页签的“前端配置 > 前端定义”中查看已发布的环境。 获取API的认证信息 APP认证(签名认证)在对API请求进行加密签名时,需要用到API所授权凭据的Key和Secret。在APIG实例控制台选择“API管理 > 凭据
“参数编排”。 GRPC API的后端FunctionGraph类型,当前仅贵阳一、上海一、北京四、上海二、圣地亚哥区域支持。 (可选)添加策略后端请参考5。 (可选)为API添加策略 发布API后,方可添加策略。 在“API运行”页面,单击“添加策略”。 选择策略类型,配置策略。
js)示例 在工程中引入signer.js。 var signer = require('./signer') var https = require('https') 生成一个新的Signer,填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本
绑定API。注意,只有通过APP认证的API才能被绑定。 在已创建凭据所在行,单击“绑定API”。 选择环境、API分组和API。 单击“确定”,完成API绑定。 添加APPCode认证信息。 在凭据列表中单击已创建的凭据名称,进入凭据详情。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中选择“自动生成”生成方式。
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
请求消息中单独传递它,所以在此单独强调。 URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从终端节点中获取。例如APIG服务在“华北-北
domain 否 String API的访问域名,未提供时根据mode的取值使用如下默认值: DEVELOPER API分组的子域名 MARKET 云商店为API分组分配的域名 CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/debug/{api_id}
如果需要对某个凭据进行流量控制,可以在“流量控制策略”中为凭据绑定流量控制策略。绑定后,该凭据的流量受特殊凭据的阈值限制,而API流量和用户流量仍受流量控制策略限制。 如果需要对某个租户进行流量控制,可以在“流量控制策略”中为租户绑定流量控制策略。绑定后,该租户的流量受特殊租户的阈值限制,而API流量和用户流量仍受流量控制策略限制。
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。