检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
中包括4个字段,导入成功的API编号id、API请求方法method、API请求路径path、导入行为action(枚举值,update表示更新API,create表示新建API)。failure数组元素中包括4个字段,API请求方法method、API请求路径path、导入失败
horization”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。 安全认证 选择API认证方式,此处选择“APP认证”。 支持双重认证 勾选后,开启双重认证。选择已创建自定义认证。 单击“下一步”,后端服务类型选择“Mock”。
导出API 表1 导出API 参数名称 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基
如何调用API 构造请求 认证鉴权 返回结果
进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,下线API。 在待下线的API所在行,单击“更多 > 下线”,弹出“下线API”对话框。 单击“API名称”,进入API详情页面。在右上角单击“下线”,弹出“下线API”对话框。 如果需要
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中
是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 401 表3 响应Body参数 参数 参数类型 描述 error_code String
表4 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,配置默认后端信息。 表5 Mock类型定义后端服务
调用API 调用APIG开放的API 跨域调用APIG开放的API APIG的API响应消息头说明 APIG的API错误码说明
开放API 使用APIG专享版开放云容器引擎CCE工作负载 使用APIG专享版开放本地数据中心的服务能力 使用APIG专享版跨VPC开放后端服务 使用APIG专享版实现gRPC服务的路由转发 使用APIG专享版实现WebSocket服务的转发 使用APIG专享版实现http到https自动重定向
方案概述 应用场景 API网关提供了灵活的安全认证方式,用户可以配置自定义认证实现API的双重认证方式。本文以API前端认证使用APP认证和自定义认证(双重认证)结合场景为例,具体说明如何创建使用双重认证的API。 方案优势 在API网关提供的安全认证模式下,用户可根据业务需求,
API策略 是否支持对API的请求并发次数做控制? 企业账号是否有调试域名每天最多可以访问1000次的限制? API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
发布API 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到不同环境后,会调用不同的后端服务吗? 调试API的时候,如何指定环境?
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
创建API 通过APIG创建REST API 通过APIG创建GRPC API 父主题: 开放API
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 api_ids 是 Array of strings
String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IA
是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 apis 否 Array of strings
API策略 使用APIG专享版的流量控制2.0策略实现API的精细流控