应用与数据集成平台 ROMA Connect-配置示例:部署并发布数据API

时间:2023-11-01 16:22:59

部署并发布数据API

  1. 调用“部署后端API”接口,部署数据后端并发布一个数据API,获取返回的前端数据API编号。

    请求示例:

    POST /v2/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id}/deploy{   "deploy_front_api" : true,   "roma_app_id" : "xxxxxx"   "auth_type" : "APP",   "group_id" : "yyyyyy",   "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",   "method" : "GET",   "path" : "/data/test",   "protocol" : "HTTPS",   "backend_timeout" : 5000,   "cors": false}

    其中加粗部分需要根据接口参数说明,替换为实际的数据值。{ld_api_id}创建数据后端时获取并保存的后端API编号,xxxxxx获取集成应用ID中获取并保存的集成应用ID,yyyyyy获取API分组ID中获取并保存的API分组ID。

    响应示例:

    {   "id" : "5e19590f54444d8a9b8fe698ce26e9fe",   "deploy_time" : "2020-09-19T06:58:13Z",   "api_id" : "1d0432f1a********ae7bd96ca6",   "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",    ...}

    响应消息中“api_id”的值即为前端数据API的编号,保存并留待后续步骤使用。

  2. (可选)在发布数据API时无法为数据API添加请求参数,若需要为数据API添加请求参数,则调用“修改API”接口为数据API添加请求参数。

    请求示例:

    PUT /v2/{project_id}/apic/instances/{instance_id}/apis/{api_id}{   "name": "Data_API",   "type": 1,   "req_protocol": "HTTPS",   "req_method": "GET",   "req_uri": "/data/test",   "auth_type": "APP",   "backend_type": "HTTP",   "group_id": "c77f5e81d********ef2b0ac7600",   "req_params": [       {           "name": "param01",           "type": "STRING",           "location": "QUERY"       }   ],}

    其中加粗部分需要根据接口参数说明,替换为实际的数据值。{api_id}发布数据API时获取并保存的前端数据API编号,“req_protocol”、“req_method”、“req_uri”、“auth_type”、“group_id”需与发布数据API时设置的值保持一致。“parameters”下可根据实际需要设置多个后端请求参数,或不设置请求参数。

support.huaweicloud.com/api-roma/roma_06_0203.html