检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 ROMA API的错误响应类型 错误响应类型 默认的响应状态码 错误说明 详细说明 ACCESS_DENIED 403 拒绝访问 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 AUTHORIZER_CONF_FAILURE
API产品 创建API产品 上架目录 管理API产品 父主题: API消费
总览 ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期
API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号,然后单击“跨域资源共享”。 图1 单击跨域资源共享 配置跨域访问控制。 选择已有策略:单击“选择已有策略”后,选择策略名称。
API目录 订阅API产品 创建凭证 通过Explorer调试API 父主题: API消费
策略管理 创建API策略 跨域资源共享策略 HTTP响应头管理策略 管理API策略 父主题: API管理
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
APIs管理 创建API 调试API 发布API 管理API 流量控制 访问控制 签名密钥 跨域资源共享 父主题: API管理
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题: 管理中心
”。 双向认证 仅当“协议”选择“HTTPS”时需要配置。 是否选择“使用backend_client_certificate配置的证书做客户端认证”,若选择,您需在实例详情的“配置参数”页签中提前配backend_client_certificate证书。 路径 仅当“协议”选
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
审核管理 为产品上架/不推荐/下架/订阅过程提供审核机制,API管理者发起上架/不推荐/下架/订阅请求时,IAM用户(其他管理者)都可以参与到评审中,让更多用户参与到API产品审视中,以确保产品的正确性。 审核流程: 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。
API租户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 认证方式为无认证时,任何公网用户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 认证方式为自定义认证时,需要在函数服务中写一段函数,对接用户自己的认证系统或服务。如果当前Region没有上线函数服务,则不支持自定义认证。
应用管理 创建应用 管理应用 父主题: 管理中心
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
自定义认证 创建自定义认证 管理自定义认证 父主题: API管理
件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。 导入规则检测通过后,单击“继续导入”。
创建凭证 凭证代表用户认证标识,用户通过凭证来订阅上架的产品,订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
SSL证书管理 创建SSL证书 管理SSL证书 父主题: API管理
API设计配置 ROMA API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段,您按照Swagger规范性设计API的同时,也可额外自定义扩展字段。