
# Open API
Open API连接器用于生成并发布一个API，该API的具体实现将由"Open API"组件的后续组件完成。因此"Open API"组件只能作为组合应用的触发事件，且后续必须连接其它节点。
流任务启动成功后，用户可以在对应ROMA Connect实例的"服务集成 APIC \> API列表"中查看并编辑该发布的API。
#### 支持的动作
接收API调用。
#### 配置参数
| 参数       | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|
| API名称    | 填写API的名称，根据规划自定义。该名称会在对应ROMA Connect实例的"服务集成 APIC \> API列表"中展示。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| 安全认证     | 选择安全认证方式，当前支持以下方式： - APP认证：表示由ROMA Connect对API请求进行安全认证。用户调用API时，使用授权集成应用的Key和Secret进行API请求的安全认证。使用该方式的API适合所有用户调用。  - IAM认证：表示由IAM对API请求进行安全认证。用户调用API时，使用Token或AK/SK进行API请求的安全认证。使用该方式的API仅适合同一云服务平台的用户调用。  - 无认证：表示API请求不需要认证。 须知： 使用无认证方式的API适合所有用户调用，安全级别低，请谨慎使用。                                                                                                                                                                                                 |
| 请求方法     | 选择API的请求方法。支持GET、HEAD、POST、PUT、DELETE。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| 请求Path   | 填写API的请求路径。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| 匹配模式     | 选择API请求路径的匹配模式。 - 绝对匹配：API请求中的请求路径要与"请求Path"的配置一致。  - 前缀匹配：API请求中的请求路径要以"请求Path"的配置为前缀。例如，"请求Path"为"/test/AA"，使用前缀匹配时，通过/test/AA/BB和/test/AA/CC都可以访问API，但是通过/test/AACC无法访问。                                                                                                                                                                                                                                                                                                                                                                                                                |
| 请求参数     | 配置API的请求参数。单击"添加"，根据业务需要定义API的请求参数。 - 名称：请求参数的名称。  - 类型：选择请求参数的类型，可选择"Header"参数和"Query"参数，如果"请求Path"中包含Path参数时，还需要配置对应的"Path"参数。  - 必填：在API请求中，请求参数是否必填。  - 默认值：仅当"必填"为"否"时可配置请求参数的默认值。如果调用API时未给该参数赋值，则会使用该默认值。   说明： 请求参数可在后续节点中通过自定义变量的形式被引用，具体请参见[自定义变量](https://support.huaweicloud.com/usermanual-codeartslink/codeartslink_03_0007.html#codeartslink_03_0007__section354201953319)。 |
| 请求Body示例 | **仅当"请求方法"选择"POST"或"PUT"时可配置**。 请求API的请求体示例。 说明： 请求Body体可在后续节点中通过节点变量的形式被引用，具体请参见[节点变量](https://support.huaweicloud.com/usermanual-codeartslink/codeartslink_03_0007.html#codeartslink_03_0007__section1961413019331)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| 响应模式     | 选择API的响应模式。 - 同步：表示API收到请求后立即执行并返回调用结果。  - 异步：表示API收到请求后先返回"响应体"并将请求排队，执行成功后再返回调用结果。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| 响应体      | **仅当"响应模式"选择"异步"时可配置**。 API收到请求后返回的响应体。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   
