政企自服务管理 ESM-查询API列表:响应

时间:2025-02-12 14:58:00

响应

  • 响应参数
    • 响应状态码200:返回ApiListResponse。
      表3 ApiListResponse对象属性

      参数

      是否必选

      类型

      值域

      说明

      api_list

      表4

      API集合

      api_total

      int32

      默认值:0

      API总数

      catalog_list

      表5

      目录集合

      catalog_total

      int32

      默认值:0

      目录总数

      表4 ApiVo对象属性

      参数

      是否必选

      类型

      值域

      说明

      id

      string

      API ID

      name

      string

      API名称

      description

      string

      API描述

      api_path

      string

      API URL

      api_type

      string

      API类型:new(新建API),exist(注册已有API,预留)

      api_protocol_type

      string

      API 协议类型:HTTPS HTTP

      request_type

      string

      API 请求类型,GET,POST

      create_time

      int64

      创建时间

      update_time

      int64

      更新时间

      publish_time

      int64

      更新时间

      project_id

      string

      所属项目

      released

      int32

      API发布标识

      successful_test

      int32

      API调试标识

      service_type

      int32

      单数据源或多数据源

      auth_type

      string

      认证类型: IAM

      create_user

      string

      创建用户

      approve_user_id

      string

      审核人

      update_user

      string

      更新用户

      api_status

      int32

      状态:1等待发布审批,2发布请求拒绝,3已发布,4下线拒绝,5等待下线审批,8待发布,7发布失败,6下线失败

      api_debug

      int32

      API调试标识:0等待调试,1调试失败,2调试成功

      body

      string

      body体(虽然为text,但是长度限制在20480,这个和apig保持一致)

      retention_period

      int64

      API最小保留期,预留

      catalog_id

      string

      所属目录id

      security_level

      string

      密级

      owner_name

      string

      owner_name

      project_name

      string

      project_name

      connection_type

      string

      connection_type

      表5 ApiCatalogVo对象属性

      参数

      是否必选

      类型

      值域

      说明

      id

      string

      ID

      name

      string

      name

      description

      string

      description

      create_time

      int64

      create_time

      create_user

      string

      create_user

      create_user_id

      string

      create_user_id

      update_time

      int64

      update_time

      update_user

      string

      update_user

      project_id

      string

      project_id

      parent_id

      string

      parent_id

      owner_name

      string

      owner_name

      project_name

      string

      project_name

  • 响应示例
    HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8
support.huaweicloud.com/api-esm/esm_08_0042.html