检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
Web”,单击“Next”。 图2 Static Web 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后JavaScript的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程JavaScript的目录结构 node_demo.js:Nodejs示例
api_id 是 String api的ID。 throttle_id 否 String 流控策略的编号 throttle_name 否 String 流控策略的名称 env_id 否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略
访问控制策略的名称。支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~64个字符。 类型 控制访问API的类型。 IP地址:限制调用API的IP地址。 账号名:仅适用IAM认证类型的API,限制调用API的账号名。仅支持配置账号名,对账号名及账号名下的IAM用户名做限制,不支持配置IAM用户名。
String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri
"app_secret": "app_secret_sample" } 响应消息 表4 参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret
当“镜像协议”为HTTP/HTTPS时设置。 镜像请求的路径,支持* % - _ .等特殊字符,总长度不超过512,且满足URI规范。如果不指定镜像请求路径,那么默认使用绑定的API的请求路径。 拼接模式 当指定镜像请求的路径后,可以设置请求路径的拼接模式。 replace模式:表示使用指定的“镜像请求路径”作为镜像请求的路径。
移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值,如下图所示: 图1 从返回消息的Header中获取X-Subject-Token 使用如下命令将token设置为环境变量,方便后续事项。
functionEndpoints 含义:API网关定义的FUNCTION类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces: - "application/json"
mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces: - "application/json"
单击“确定”,生成参数header为Host对应的匹配规则“Host = www.abc.com”,表示在60s内,对于请求头中Host参数等于“www.abc.com”的API,且API调用次数达到10,参数流控生效。 根据3、4,定义参数Path对应的多重规则。 在“定义规则”区域,单击
单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer 单个源IP流控时间内能够访问API的次数限制 time_interval Integer 流控的时长 time_unit
当后端服务没有在设置的后端超时时间内返回时,API网关提示后端服务调用失败。 在编辑API中增加后端超时时间,或缩小后端的处理时间。 如果“后端服务地址”在ECS(Elastic Cloud Server),ECS的安全组的出/入方向规则可能拦截了请求。 检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。
httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces: - "application/json"
如果需要批量发布API,则勾选待发布的API,单击“发布”。最多同时发布1000个API。 选择API需要发布到的环境,并填写发布说明。 图1 发布API 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“发布”,完成API发布。
String API的认证方式 group_name String API所属分组的名称 publish_id String API的发布记录编号 throttle_apply_id String 与流控策略的绑定关系编号 apply_time String 已绑定的流控策略的绑定时间 remark
含义:API网关定义的API后端服务定义。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get: produces: - "application/json"
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/i
自定义认证配置 推送的日志中,需要携带的自定义认证信息。 前端:填写日志中要携带的前端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 后端:填写日志中要携带的后端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 单击“确定”。 如果您需要复制已创建的策略,请在已