检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括允许和禁止。 和“限制类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 单击“增加IP地址”,输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“限制类型”为“IP地址”时,需要设置。
仅在使用VPC通道时,需要设置。选择已创建的负载通道名称。 说明: VPC通道中,云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 格式:“主机:端口”,主机为IP地址/域名,未指定端口时,HTTP协议默认使用80
问密钥ID(AK),秘密访问密钥(SK)由IAM用户自行保管。 AK/SK生成步骤: 登录控制台。 将鼠标移至页面右上角的用户名处,在下拉列表中单击“我的凭证”。 单击“访问密钥”。 单击“新增访问密钥”,进入“新增访问密钥”页面。 每个用户最多可创建2个访问密钥,不支持增加配额
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。 页面左侧展示凭证列表,页面右侧展示对应凭证信息以及通过该凭证订阅的产品信息。 单击“创建凭证”,填写凭证基本信息。 图1 填写基本信息 单击“确定”,创建完成。
选择后端服务类型,此处选择“HTTP&HTTPS”。 负载通道 “不使用”负载通道。 URL URL地址 请求协议:HTTP 后端服务地址:192.168.1.1:1234为•步骤四:后端开发部署后的后端服务地址或用户自己的后端服务地址。 自定义host头域 为简单起见,此处不配置。 后端超时 请求超时时间,此处填写“5000”ms。
I测试覆盖。 使用场景 API上线后,测试API连通性,以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理
管理应用 创建应用成功后,在“应用管理”的列表中显示新创建应用的基本信息,同时也支持权限管理、编辑、删除等操作管理应用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务,了解如何管理应用。
API服务变更后,需要手动同步信息到产品。 选择变更API服务所属产品,单击产品名称。 在“版本列表”中选择同步版本。 在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地,用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
发送API请求时,需要将当前时间置于请求消息头的X-Sdk-Date,将签名信息置于请求消息头的Authorization。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 ROMA API除了校验时间格式外,还会校验该时间值与ROMA API收到请
编辑”,修改流水线的执行步骤及参数。 单击“更多 > 取消关联”,取消流水线与后端的关联。 后续操作 您可以下载流水线执行成功后的jar包,将jar包部署到自己的服务器上,在控制台配置API后端服务即可。 父主题: API实现
/app1/ a=1&b=2 添加规范消息头(CanonicalHeaders),以换行符结束。 释义: 规范消息头,即请求消息头列表。包括签名请求中的所有HTTP消息头列表。消息头必须包含X-Sdk-Date,用于校验签名时间,格式为ISO8601标准的UTC时间格式:YYYYMMDDTH
使用app_secret认证时,需同时关闭app_api_key认证方式。 app_route 支持IP访问开关。启用后,非DEFAULT服务下的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关。启用后,创建API配置后端服务时,可配置后端双向认证。 ssl_ciphers
审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。 订阅API B部门在“目录列表”中订阅API产品。 单击“订阅”,填写订阅申请信息。 图4 订阅申请 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。
配置说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。 绑定API 登录ROMA
requestId 当次API调用生成请求ID $context.stage API调用的部署环境 $context.sourceIp API消费者的源地址 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值
访问日志的字段采用空格作为分隔符,按照顺序,每个字段的含义如下: 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID 4 user_id 当使用IAM认证访问时,请求方提供的项目ID 5
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
取用于调用API的SDK。 自定义认证:向API管理者获取请求参数中要携带的自定义认证信息。 无认证:无需认证信息。 调用API 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API ROMA API允许使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。