开放API-华为云

应用与数据集成平台 ROMA CONNECT-创建API:定义API请求

定义API请求定义API的请求信息。表2 API请求配置参数配置说明请求协议选择API使用的请求协议，可选择“HTTP”、“HTTPS”和“HTTP&HTTPS”，传输重要或敏感数据时推荐使用HTTPS。请求Path 填写API的请求路径，格式如：/getUserInfo/{userId}。请求路径中可包含Path参数，以{参数名}形式表示。 Path参数应匹配“/”之间的一整段，不支持匹配“/”之间的一部分，例如不支持/abc{userId}。若匹配模式为绝对匹配，则尾部的Path参数可以添加+号，例如/users/{p+}，其中变量p匹配一或多段“/”之间的部分。请求路径中包含Path参数时，必须配置对应的入参定义。请求路径中的内容区分大小写。匹配模式选择API请求路径的匹配模式。绝对匹配：API请求中的请求路径要与“请求Path”的配置一致。前缀匹配：API请求中的请求路径要以“请求Path”的配置为前缀。例如，“请求Path”为“/test/AA”，使用前缀匹配时，通过/test/AA/BB和/test/AA/CC都可以访问API，但是通过/test/AACC无法访问。说明：使用前缀匹配时，匹配剩余的请求路径将透传到后端服务。例如，“请求Path”为“/test”，“后端请求Path”为“/test2”，使用前缀匹配时，通过/test/AA/CC访问API，后端服务收到的请求路径为/test2/AA/CC。 Method 选择API的请求方法。“ANY”表示该API支持任意请求方法。支持CORS 是否支持跨域访问API。浏览器出于安全性考虑，限制从页面脚本内发起的跨域请求，此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求，从而实现跨域访问。跨域访问API请参见配置跨域访问API。入参定义（可选）根据实际需要定义API的请求参数。请求路径中包含请求参数时，必须配置对应的入参定义。在“入参定义”下单击“添加入参定义”，添加API的请求参数。参数名：请求参数的名称。参数位置为“PATH”时，参数名需要与“请求Path”中的参数名称一致。参数位置：请求参数在API请求中的位置，可选择“PATH”、“HEADER”和“QUERY”。类型：选择请求参数的数据类型，可选择“STRING”和“NUMBER”。必填：在API请求中，请求参数是否必填。透传：请求参数是否透传到后端服务。默认值：仅当“必填”为“否”时可配置请求参数的默认值。枚举：请求参数的枚举值，请求参数的值只能从枚举值中选择，多个枚举值间用英文逗号隔开。最大长度/最大值：“类型”为“STRING”时，设置参数值的最大字符串长度，“类型”为“NUMBER”时，设置参数值的最大值。最小长度/最小值：“类型”为“STRING”时，设置参数值的最小字符串长度，“类型”为“NUMBER”时，设置参数值的最小值。最小长度/最小值和最大长度/最大值同时设置成0时，表示不做限制。示例：请求参数值的填写示例。描述：请求参数的描述信息。说明：参数名不能以x-apig- 、x-sdk-开头，不能是x-stage，不区分大小写。参数位置为HEADER时，参数名不能是Authorization和X-Auth-Token，不区分大小写。请求体内容描述仅当“Method”选择“POST”、“PUT”、“PATCH”或“ANY”时可配置。填写API请求中请求体的描述信息，用于帮助API调用者理解如何正确封装API请求。完成后单击“下一步”，定义后端服务。

应用与数据集成平台 ROMA CONNECT 开放API

应用与数据集成平台 ROMA CONNECT-创建API:前提条件

前提条件每个API都要归属到某个集成应用下，在创建API前您需要有可用的集成应用，否则请提前创建集成应用。每个API都要归属到某个API分组下，在创建API前您需要有可用的API分组，否则请提前创建API分组。如果需要使用负载通道访问后端服务所在的服务器，请提前创建负载通道。如果需要使用自定义认证方式进行API的安全认证，请提前创建自定义认证。在创建API前，请确保ROMA Connect实例与您的后端服务所在网络互通。若ROMA Connect实例与后端服务在相同VPC内时，可直接访问后端服务。若ROMA Connect实例与后端服务在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问后端服务。具体步骤请参考VPC对等连接说明。若ROMA Connect实例与后端服务在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问后端服务。具体步骤请参考跨区域VPC互通。若ROMA Connect实例与后端服务通过公网互通，请确保ROMA Connect实例已绑定弹性IP。若ROMA Connect实例跨VPC内网访问后端服务时，需要完成实例到后端服务所在子网的路由配置。使用FunctionGraph作为API的后端服务时，用户需要具备FunctionGraph Administrator角色权限。

应用与数据集成平台 ROMA CONNECT 开放API

API网关 APIG-创建API:后端配置

后端配置在“后端配置”页面，配置后端服务信息。选择后端服务类型，此处选择“HTTP&HTTPS”。表3 HTTP&HTTPS类型定义后端服务服务参数参数说明负载通道选择“不使用”负载通道访问后端服务。 URL 请求方法：API调用方式，此处选择“POST”。请求协议：选择协议类型，此处选择“HTTP”。后端服务地址：后端服务的地址。路径：后端服务的路径。后端超时后端服务请求的超时时间。此处默认“5000”ms。在“返回结果基础定义”页面，定义返回结果。表4 定义返回结果信息项描述成功响应示例成功调用API时，返回的响应信息示例。失败响应示例调用API失败时，返回的响应信息示例。单击“完成”，完成API的创建。

API网关 APIG 开放API

应用与数据集成平台 ROMA CONNECT-绑定域名:获取域名

获取域名云服务平台内业务系统访问API的场景，需获取内网域名作为独立域名。申请内网域名，具体请参考创建内网域名。配置域名到“服务集成APIC 连接地址”的A类型记录集配置，具体请参考增加A类型记录集。如果API分组中的API支持HTTPS请求协议，则需要为独立域名添加SSL证书。您需要提前获取SSL证书的内容和密钥，并创建SSL证书。云服务平台外业务系统访问API的场景，需获取公网域名作为独立域名。申请公网域名，具体可通过域名注册服务申请。备案公网域名，您可以通过备案中心完成域名备案。备案时长需几个工作日，建议您提前进行备案。配置域名到API分组子域名的CNAME类型记录集配置，具体请参考增加CNAME类型记录集。如果API分组中的API支持HTTPS请求协议，则需要为独立域名添加SSL证书。您需要提前获取SSL证书的内容和密钥，并创建SSL证书。

应用与数据集成平台 ROMA CONNECT 开放API

应用与数据集成平台 ROMA CONNECT-创建负载通道（可选）:前提条件

前提条件 ROMA Connect与负载通道中服务器之间的网络互通。若ROMA Connect实例与服务器在相同VPC内时，可直接访问服务器。若ROMA Connect实例与服务器在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问服务器。具体步骤请参考VPC对等连接说明。若ROMA Connect实例与后端服务在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问服务器。具体步骤请参考跨区域VPC互通。若ROMA Connect实例与服务器通过公网互通，请确保ROMA Connect实例已绑定弹性IP。用户账号需要具备VPC Administrator角色权限。

应用与数据集成平台 ROMA CONNECT 开放API

云服务器内容精选

开放API

7*24

备案

专业服务

退订

建议反馈

售前咨询热线