检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 使用APP认证调用API APP认证需要通过SDK访问。 使用IAM认证调用API 支持Token认证和AK/SK认证两种。 Token认证：通过Token认证调用请求。Token认证无需使用SDK签名，优先使用Token认证。 AK/SK认证：通过AK（Access Key
您可以通过创建API，把已有后端服务封装成标准的RESTFul API，并开放给其他用户使用。 创建API主要步骤：设置前端定义和安全配置和后端配置。 前提条件 已创建API服务。如果未创建API服务，请参考创建API服务。 如果后端服务需要使用VPC通道，请参考创建负载通道。 设置前端定义和安全配置
在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务，了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。
401 运行服务器，验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后，单击“Send request”，复制生成的curl命令，并在命令行中执行，服务器返回200。 如果使用错误的Key和Secret访问，服务器返回401认证不通过。
在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。 已发布到环境的API，在修改配置信息
供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证，填写申请描述。 您可以使用已有的凭证或者新建凭证，新建凭证具体操作请参考创建凭证。
API测试 通过导入API生成测试用例，快速实现API测试覆盖。 使用场景 API上线后，测试API连通性，以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
1中调用此API时，后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”，变量值“/Stage/AA”，则API在发布到环境2时，使用“/Stage/AA”代替“#Path#”，API消费者在环境2中调用此API时，后端服务请求Path为“/Stage/AA”。
API通过此函数对接后端认证系统，获取后端服务的访问授权。 自定义认证依赖函数服务。如果当前Region没有上线函数服务，则不支持使用自定义认证。 自定义认证的具体使用指导，可参考《 应用与数据集成平台 ROMA Connect 开发指南》的自定义认证相关章节。 前提条件 已在函数工作流服务中完成函数创建。
表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。 导入规则检测通过后，单击“继续导入”。
上架目录 将API产品上架到API目录，供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品，单击产品名称。 在“版本列表”中，选择上架版本，单击“上架”。
计费说明 ROMA API本身不收费，但需先关联资源才可使用对应功能。请参考： 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
API调用场景 API请求参数配置 使用域名调用API ROMA API允许使用服务分配的子域名或服务绑定的域名调用API，无需另外配置。 使用IP调用API ROMA API的实例配置参数“app_route”已设置为“on”，允许通过IP访问API。 允许使用IP地址调用API，无需另外配置。
创建应用 开始使用ROMA API前，您需要先创建应用，然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源，IAM用户只能管理自己创建的应用和资源，默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式，把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。
运行服务器，验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后，单击“Send request”，复制生成的curl命令，并在命令行中执行，服务器返回“Hello World!”。 如果使用错误的Key和Secret访问，服务器返回401认证不通过。
请求参数说明 认证方式 Headers Parameters Body APP认证 说明： APP认证凭证：选择已创建凭证，可选择的凭证是已使用凭证订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。
C# 操作场景 使用C#语言进行后端服务签名时，您需要先获取SDK，然后打开工程，最后参考校验后端签名示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual
安全认证 API使用的认证方式，推荐使用APP认证。 APP认证：表示由ROMA API进行API请求的安全认证。 华为IAM认证：表示通过IAM服务进行安全认证。 自定义认证：表示使用自定义的后端函数API进行安全认证。 无认证：表示不需要认证。 须知： 使用IAM认证方式时，
API概念，提供的能力，以及操作指引。 您可以根据不同角色查看行为路径，或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者，敬请期待。 API治理专家，敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器，支持编辑器编辑和表单编辑两种方式，并提供规范性检查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线，降低开发时间。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
