查询API列表

功能

查询API列表。

注意事项

无

调用方法

GET

URI

/rest/gaia/dataapi/v1/api/querylist

路径参数

无

请求

• 请求header参数

  请参见请求示例中header描述。

• 请求body参数

  无

• 请求示例

  GET /rest/gaia/dataapi/v1/api/querylist?start=xxx&limit=xxx&name=xxx&full_name=xxx&catalog_id=xxx&catalog_parent_id=xxx&api_status=xxx&api_debug=xxx&start_time=xxx&end_time=xxx&create_user=xxx&sort_key=xxx&sort_dir=xxx&api_path=xxx&request_type=xxx&project_id=xxx HTTP/1.1 
  Host: example.com 
  Content-Type: application/json 
  Accept: application/json

响应

• 响应参数
  • 响应状态码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

状态码

操作危险级别

Minor