检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
例。 在需要生成产品的API服务所在行单击“生成产品”。 填写产品基本信息。 在“添加版本和API”区域，选择是否创建产品版本，版本号、实例和API服务，勾选API。 只有已部署到RELEASE环境中的API，才能被添加到API产品中。 每个API仅能被添加到一个API产品，无法同时添加到多个产品中。
根据API使用的安全认证方式，还要获取相关的请求认证信息： APP认证： 签名认证：向API管理者获取该API所授权应用的Key和Secret（或客户端的AppKey和AppSecret），以及用于调用API的SDK。 简易认证：向API管理者获取该API所在应用的AppCode。 其他认证：
选择授权应用。 设置访问参数。 选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。
选择实例的计费模式，此处选择“按需计费”。 区域 选择实例所在的区域，此处选择“华北-北京四”。 可用区 选择实例所在的可用区，此处选择“可用区1”。 实例名称 填写实例的名称，根据规划自定义。建议您按照一定的命名规则填写实例名称，方便您快速识别和查找。 实例规格 选择实例的容量规
ROMA API为企业构建规范化的API全流程体系，将企业服务能力包装成标准API服务，上架市场进行售卖。变现自身服务能力的同时，降低企业研发投入，专注于企业核心业务，提升运营效率。提供全栈的API数据化运营能力，用运行数据驱动规范跟设计的落地，提供更高维度的顶层API架构设计能力。
参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称，请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线，当前仅支持在官方提供的流水线中选择。当前提供的流水线为手动触发流水线，在
使用APP认证方式的API，支持通过AppCode进行API调用的简易安全认证。 绑定凭据配额策略 凭据配额用于限制凭据在某个时间周期内的API调用次数，支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址，保护后端服务。您可以为客户端设置访问控制策略
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
签名密钥用于后端服务验证API的身份，在API请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，当签名密钥创建后，ROMA API向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果与请求的Autho
API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明
从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动生成API框架代码和测试用例，依托CICD（Continuous
API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A通过开放业务能力，使自身服务能力变现，部门B直接订阅部门A开放的API，减少开发时间和成本，实现部门之间业务共享。
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 选择待调试的API，配置API请求参数后，单击“调试”。
不论“default（默认）”或是您自定义的网关响应，响应类型范围固定不可修改。您可以修改每种响应的状态码，以及响应内容。 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。
自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 选择需要发布的API，在页面右上角单击“发布”。 如需批
API产品是从服务中挑选想要共享的API组合而成，即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费
在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次
给请求添加x-stage头，内容为环境名。如有需要，添加需要签名的其他头域。 1 r.headers.Add("x-stage", "RELEASE"); 进行签名，执行此函数会生成一个新的HttpWebRequest，并在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
