检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证,填写申请描述。 您可以使用已有的凭证或
仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 选择健康检查所使用的HTTP请求方法,可选择“GET”和“HEAD”。 高级设置 检查端口 健康检查的目标端口,默认使用负载通道配置的端口号,但您可以指定其他的端口。 正常阈值 执行健康检查时,判定服务器状态正常的连续检查成功
创建应用 开始使用ROMA API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。
单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。 权限管理 通过设置权限管理,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 具体操作请参考应用授权。 编辑应用 支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发
与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用,表示单位时间内的单个APP请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用,表示单位时间内的单个API请求次数上限。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API服务绑定。 如果不再需要此域名时,在域名所在行,单击“解绑域名”。
已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Python安装包(可使用2.7或3.X),如果未安装,请至Python官方下载页面下载。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ IDEA官方网站下载。 已在IntelliJ
C# 操作场景 使用C#语言进行后端服务签名时,您需要先获取SDK,然后打开工程,最后参考校验后端签名示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual
运行服务器,验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后,单击“Send request”,复制生成的curl命令,并在命令行中执行,服务器返回“Hello World!”。 如果使用错误的Key和Secret访问,服务器返回401认证不通过。
创建API 创建API策略 OBS 2.0支持API消费 主要介绍API管理者如何将API服务转换为产品,上架到API目录供API消费者查看和使用。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API产品 上架API目录 订阅API产品
API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务,了解如何管理API产品。 表1 管理产品 相关任务 使用场景 操作步骤 创建新版本 创建产品新版本,同步产品基本信息,可自行添加API。 单击需要创建新版本的产品名称。 在产品详情页面,单击“创建新版本”。
业务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力 APIG实例: 需要实现API的开放托管,安全等配置 使用一些基础的API编排集成能力 前提条件
每个用户最多创建200个API产品图标。 √ API产品版本中的API数量 每个API产品版本最多添加100个API。 √ 凭证数量 每个用户最多创建50个凭证。 √ 其他配额请参考APIG配额管理、ROMA Connect配额管理、CodeArts配额管理。
根据下表相关任务,了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略,或单击策略名称,进入策略详情。 单击“编辑”,修改策略信息,具体操作请参考创建API策略。 删除策略 删除不再使用的策略。 单击策略名称,进入策略详情。 未绑定API的策略,单击右上角“删除”。
成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
计费说明 ROMA API本身不收费,但需先关联资源才可使用对应功能。请参考: 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。