更新时间:2024-07-03 GMT+08:00
分享

查看APP下路径冲突的API列表

功能介绍

查询指定APP下路径冲突的API列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/apic/instances/{instance_id}/app-auths/duplicate-apis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

String

实例ID

表2 Query参数

参数

是否必选

参数类型

描述

app_id

String

应用ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

apis

Array of ApiDuplicationInfo objects

应用下所有路径冲突的API信息列表

表5 ApiDuplicationInfo

参数

参数类型

描述

req_method

String

请求方式

req_uri

String

API的访问地址

match_mode

String

API的匹配方式

  • SWA:前缀匹配
  • NORMAL:正常匹配(绝对匹配) 默认:NORMAL

duplicated_apis

Array of DuplicateApiInfo objects

该路径下冲突的API列表

表6 DuplicateApiInfo

参数

参数类型

描述

api_id

String

API ID

api_name

String

API名称

group_name

String

分组名称

group_id

String

分组ID

remark

String

API描述

api_type

String

API类型:

  • self-owned:自有API
  • authorized:授权API

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码: 200

OK

{
  "total" : 1,
  "size" : 1,
  "apis" : [ {
    "req_uri" : "/test/function",
    "req_method" : "GET",
    "match_mode" : "NORMAL",
    "duplicated_apis" : [ {
      "api_id" : "e25fcb255a664e80aa40759d37d043e9",
      "api_name" : "api_demo",
      "group_id" : "86d75a6b1d6c4cca99e1bed795074167",
      "group_name" : "DEFAULT",
      "api_type" : "self-owned"
    }, {
      "api_id" : "d41f91f14ecc476fa9bdef54afb37f06",
      "api_name" : "api_demo_duplicate",
      "group_id" : "c3053da9dcd54ffba3bf6e0fb7721a82",
      "group_name" : "EchoDemo",
      "api_type" : "self-owned"
    } ]
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation"
}

状态码: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

Not Found

{
  "error_code" : "APIG.3004",
  "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档