应用与数据集成平台 ROMA Connect-配置示例:获取API分组ID

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

获取API分组ID

API分组是同一类业务API的集合,每个API都要归属到某个API分组下,在发布数据API前需要获取API所归属的API分组ID。

API只有在发布到环境后,才能被外部用户调用,在发布数据API前需要获取API要发布的环境ID。
  • 如果有可用的API分组,则调用“查询分组列表”接口,获取分组ID。
    请求示例:
    GET /v2/{project_id}/apic/instances/{instance_id}/api-groups

    其中加粗部分需要根据接口参数说明,替换为实际的数据值。

    响应示例:

    {   "total" : 2,   "size" : 2,   "groups" : [ {     "name" : "api_group_001",     "id" : "c77f5e81d********ef2b0ac7600",     "remark" : "group1",      ...   },   ...  ] }

    响应消息中“groups”的值为查询到的API分组列表,找到要使用的API分组,其中“id”的值即为API分组ID,保存并留待后续步骤使用。

  • 如果没有可用的API分组,则调用“创建API分组”接口,创建一个API分组并获取分组ID。
    请求示例:
    POST /v2/{project_id}/apic/instances/{instance_id}/api-groups{   "name" : "api_group_001",   "version" : "V2",   "roma_app_id" : "xxxxxx"}

    其中加粗部分需要根据接口参数说明,替换为实际的数据值。xxxxxx获取集成应用ID中获取并保存的集成应用ID。

    响应示例:

    {   "name" : "api_group_001",   "id" : "c77f5e81d********ef2b0ac7600",   "remark" : "group1",    ...}

    响应消息中“id”的值即为API分组ID,保存并留待后续步骤使用。

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