检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在页面上单击服务名称,进入API服务详情页面。 在“网关响应”区域,即可新增或编辑网关响应。 如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
在页面右上角单击“API设计配置”。 在“API设计配置”页面,单击“扩展字段配置”。 单击“添加扩展字段”,定义扩展字段。 表1 定义扩展字段 信息项 描述 Key 填写Key值。 显示名 填写扩展字段名称。 显示样式 填写扩展字段的值,支持文本框、单选框、复选框和下拉列表的形式。 配置值 填写扩
单击“配置参数”页签。 在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期 本手册主要介绍以API设计者、API开发者、API管理者和API消费者角色和流程来定义API的生命周期,包含了API设计、API实现、API管理
检查。 单击“详情”查看工作流及参数配置。 单击“更多 > 编辑”,修改流水线的执行步骤及参数。 单击“更多 > 取消关联”,取消流水线与后端的关联。 后续操作 您可以下载流水线执行成功后的jar包,将jar包部署到自己的服务器上,在控制台配置API后端服务即可。 父主题: API实现
中级使用者入门 05 实践 弹性云服务器(Elastic Cloud Server)是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 部署web环境 什么是ECS 创建容器应用基本流程 快速创建一个kubernetes集群 3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用
API设计 创建API设计 API设计配置 管理API设计
准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 获取SDK 下载SDK的最新版本,获取“ApiGateway-csharp-sdk
添加API的标签信息,用于快速过滤和查找API。 描述 填写API的描述信息。 根据下表参数定义,配置安全配置。 表2 安全配置参数 信息项 描述 安全认证 API认证方式: APP认证:表示由ROMA API服务负责接口请求的安全认证。 华为IAM认证:表示借助IAM服务进行安全认证。 自定义认证:用户有自己
在“应用管理”中找到2中应用,单击该应用后的“权限管理”进行授权配置。 主账号可以对所有IAM用户创建的应用进行授权配置,IAM用户只能对自己创建的应用进行授权配置。 在弹窗中“用户列表”处勾选要授权的IAM用户,在“已选择”处为已选择的IAM用户配置应用的使用权限。 可为每个用户单独配置权限,也可以单击“权限”右侧的为所有已选择IAM用户批量配置权限。
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
在“API接口”列表中勾选要开放的API,单击“立即导入”。 (可选)单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式,推荐使用APP认证。 APP认证:表示由ROMA API进行API请求的安全认证。 华为IAM认证:表示通过IAM服务进行安全认证。
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
获取并安装Nodejs安装包,如果未安装,请至Nodejs官方下载页面下载。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ IDEA官方网站下载。 已在IntelliJ IDEA中安装NodeJS插件,如果未安装,请按照图1所示安装。 图1 安装NodeJS插件
无问题修复,请单击“继续导入”。 选择步骤一中实例,填写服务名称,并选择API接口。 单击“全局配置(可选)”,定义API服务。 图5 全局配置 安全配置:选择认证方式,此处选择“APP认证”。 后端请求配置。 表4 后端请求参数配置 参数 配置说明 后端服务类型 选择后端服务类型,此处选择“HTTP&HTTPS”。
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题: 管理中心
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。 操作步骤。 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费