正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API服务 API服务是同一种业务API的集合,API开发者以API服务为单位,管理服务内的所有API。 API产品 API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。 API目录 API目
ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
API策略创建完成后,在API策略列表中显示新建策略,同时也支持编辑、删除、绑定API等操作。 前提条件 已创建策略。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。
选择是否开启绿色通道。 说明: 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。
(可选)如果API服务中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“选择SSL证书”。 在选择SSL证书弹窗中勾选要绑定的SSL证书,然后单击“确定”,完成SSL证书的绑定。 若证书列表中无可用的SSL证书,可单击“创建S
单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到需要删除的自定义认证,单击所在行的“删除”,即可删除自定义认证。 更新自定义认证 刷新自定义认证信息。
共享流控:针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。 与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用,表示单位时间内的单个APP请求次数上限。
查看单个API设计文件的变更历史 单击对应API设计文件所在行的“变更历史”,即可查看相关操作记录。 单击对应操作所在行的“查看对比”,查看变更前和变更后的对比信息。 (可选)差异对比,可任意选择两个操作,单击“差异对比”,查看变更前后的信息。 如需还原操作,单击对应操作所在行的“还原”,还原到当前版本。
参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称,请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线,当前仅支持在官方提供的流水线中选择。当前提供的流水线为手动触发流水线,在
您可以在线调试API,确保API的功能正常。 步骤八:绑定域名 创建API服务生成的域名仅用于调试使用,您需要为API服务绑定独立的访问域名。 步骤九:创建产品 将已创建的API服务生成产品。 步骤十:上架目录 将生成的产品上架到目录中,供消费者查看和订阅。 步骤十一:订阅产品 在API目录中,订阅产品。
oken”,“X-Auth-Token”的取值为1中获取的Token。 接口调用示例 本小节介绍使用API的基本流程。 获取相关信息。 已获取IAM的Endpoint,具体请参见地区和终端节点。 在管理控制台,将鼠标移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 获
服务端在空闲的情况下会逐个处理排队的请求。 后端超时 请求超时时间,1 ~ 60000ms。 后端认证 当您的后端服务需要对API调用增加自己的认证,则需要开启后端认证。 后端认证需要先添加一个自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。
G”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。 描述 对于此参数的描述。 单击“下一步”,进入后端配置。
配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管
应用状态显示异常是什么原因? 应用的状态基于应用关联的资源状态来显示: 应用关联的ROMA/APIG实例状态异常,或者关联ROMA集成应用不存在时,应用资源会变成异常状态。 有一个应用资源状态显示异常,整个应用的状态就会显示异常。 修复或移除对应的异常资源,应用状态会恢复正常。
、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下,相同请求路径的所有API,只能绑定同一个跨域资源共享策略。 若API开启了“支持CORS”功能的同时,也绑定了跨域资源共享策略,则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API,则该请
单击规则名称,可查看规则的“正确示例”和“错误示例”。 (可选)编辑规则集,可单击“管理”或“编辑”。 管理:配置规则。 取消已启用规则 在“已启用”的规则中,勾选需要取消启用的规则,单击“取消启用”。 启用规则 在“未启用”的规则中,勾选需要启用的规则,单击“启用”。 编辑:修改规则集名称和描述。
在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次
L1:基本功能验证,可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2:重要特性验证,可用于测试版本(非回归版本)中功能测试。 L3:一般功能/非重要功能验证,包括对基本/重要功能的异常测试。 L4:非常特殊输入、场景、阈值条件的用例。 用例描述 用例的描述信息。 选择API接