检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在弹窗中修改“名称”,或默认系统自动生成的名称;根据下表说明,选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法,使描述信息更直观。
表2 配置凭据配额策略 参数 配置说明 策略名称 填写客户端配额策略的名称,根据规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。
发布历史 查看API发布的历史记录。 选择需要查看的API。 选择“更多 > 发布历史”。 批量操作 批量发布、下线或删除API。 单击“批量操作”,勾选需要批量操作的API。 发布,请单击。 下线,请单击。 删除,请单击。 父主题: APIs管理
SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。
在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。
在管理控制台,将鼠标移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。
在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用
调用已发布的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 获取API的请求消息 在调用API前,您需要向API管理者获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用的安全认证方式
订阅API产品 API目录相当于一个资产中心,以产品的形式将API资源上架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。
当API响应中存在多个与指定响应头相同名称的响应头时,删除所有相同名称的响应头。 skip:跳过 当API响应中存在指定的响应头时,跳过当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时,均不作处理直接返回。 当API响应中不存在指定的响应头时,添加当前响应头。
选择需要编辑的策略,或单击策略名称,进入策略详情。 单击“编辑”,修改策略信息,具体操作请参考创建API策略。 删除策略 删除不再使用的策略。 单击策略名称,进入策略详情。 未绑定API的策略,单击右上角“删除”。
在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“API Proxy”右上方的加号,然后单击“签名密钥”。 图1 单击签名密钥 配置签名密钥。 选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。
在页面上单击服务名称,进入API服务详情页面。 在“环境变量”区域,单击“添加环境变量”,选择待添加变量的环境名称。 填写变量相关信息,单击“确定”。 图2 新增变量 表1 新增变量 参数 配置说明 变量名 变量的名称,必须与创建API时定义的变量标识完全相同。
表1 流控策略信息 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控:针对单个API进行流量统计和控制。 共享流控:针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。
您可以根据不同角色查看行为路径,或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者,敬请期待。 API治理专家,敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
后端开发 2021年5月 序号 功能名称 功能描述 相关文档 1 全局APP 应用支持多区域、多资源管理。 应用管理 2 审核管理 为产品上架/不推荐/下架过程提供审核机制,让更多用户参与到API产品审视中,以确保产品的正确性。
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
单击产品名称。 在“版本列表”中选择版本。 单击“添加API”。 在弹窗中选择API,单击“确定”。 后续操作 如需对外提供API服务,可将API产品上架目录。 父主题: API产品
在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择待调试的API,配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。