检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A通过开放业务能力，使自身服务能力变现，部门
PI业务。 API策略 支持传统策略和插件策略。传统策略包括流量控制、访问控制、签名密钥；插件策略包括跨域资源共享、HTTP响应头管理以及更多的插件能力，进而提供更丰富的API安全、运维能力。 API测试 通过导入API生成测试用例，快速实现API测试的覆盖。 API消费 ROMA
ROMA API的错误响应类型 错误响应类型 默认的响应状态码 错误说明 详细说明 ACCESS_DENIED 403 拒绝访问 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 AUTHORIZER_CONF_FAILURE 500 自定义认证配置错误 自定义认证方异常，通信失败、返回异常响应等错误
API设计 创建API设计 管理规则集 API实现 创建后端 API管理 创建API服务 绑定域名 创建API 授权API 跨域资源共享策略 HTTP响应头管理策略 自定义认证 流量控制 访问控制 签名密钥 API消费 创建API产品 上架目录 订阅API产品 创建凭证 审核管理 调用已发布的API
使用自定义认证调用API Function API通过编写函数脚本实现将多个服务封装成一个服务。 有关API调用的认证帮助，请参考编写函数API脚本（Java Script）。
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
cret）进行API的调用认证。 使用app_secret认证时，需同时关闭app_api_key认证方式。 app_route 支持IP访问开关。启用后，非DEFAULT服务下的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关
络部署。 您可以在VPC中定义安全组、VPN、IP地址段、带宽等网络特性。用户可以通过VPC方便地管理、配置内部网络，进行安全、快捷的网络变更。同时，用户可以自定义安全组内与组间弹性云服务器的访问规则，加强弹性云服务器的安全保护。 支持区域：华北-北京一、华北-北京四、华东-上海一、华南-广州
填写负载通道的名称，根据规划自定义。建议您按照一定的命名规则填写负载通道名称，方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法，负载通道通过分发算法确定请求被发送到哪台服务器上。 健康检查配置 协议 选择健康检查所使用的协议，可选择“TCP”、“HTTP”和“HTTPS”。
调用API 调用已发布的API 配置跨域访问API 错误码 父主题： API消费
APIs管理 创建API 调试API 发布API 管理API 流量控制 访问控制 签名密钥 跨域资源共享 父主题： API管理
填入如图所示字段后，单击“Send request”，复制生成的curl命令，并在命令行中执行，服务器返回200。 如果使用错误的Key和Secret访问，服务器返回401认证不通过。 父主题： 对后端服务进行签名
填入如图所示字段后，单击“Send request”，复制生成的curl命令，并在命令行中执行，服务器返回200。 如果使用错误的Key和Secret访问，服务器返回401认证不通过。 父主题： 对后端服务进行签名
签名密钥是由一对Key和Secret组成，当签名密钥创建后，ROMA API向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果与请求的Authorization头中签名是否一致来校验API请求是否合法。 同一个环境中一个API只能添加一个签名密钥，一个签名密钥可以添加到多个API上。
账号用户可管理其下所有IAM用户所创建的应用和资源，IAM用户只能管理自己创建的应用和资源，默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式，把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA Connect实例或APIG实例。
API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统，API的管理者可将API包装成产品上架到API目录中供其他订阅者使用，订阅者可通过查看API的详细
全量定义：包括API前端请求定义、后端服务定义和响应定义。 扩展定义：包括API前端请求定义、后端服务定义和响应定义，还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择导出的API服务文件格式，可选择JSON或YAML。 自定义版本 填写导出API的版本号，如果没有指定版本号，默认使用当前时间作为版本号。
在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。 已发布到环境的API，在
API产品”。 选择待申请的产品，单击产品名称。 选择待申请的版本，单击“上架/不推荐/下架”，填写申请。 已上架的产品修改产品信息后需要提交申请，审核通过后才能修改成功。 单击“确定”，并返回“API产品”页面。 查看申请 在左侧导航栏选择“API消费 > 审核管理”。 单击“我提交的申请”页签。
2021年6月 序号 功能名称 功能描述 相关文档 1 凭据管理 凭据策略用于API运行时的策略管理，支持配置APPCode、绑定应用配额策略和绑定访问控制策略，且只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
