Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Application Authorization Management/ Querying APIs with Path Conflicts in an App
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying APIs with Path Conflicts in an App

Function

This API is used to query the APIs with path conflicts in a specified app.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

App ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

apis

Array of ApiDuplicationInfo objects

APIs with duplicate paths in the application.
Table 5 ApiDuplicationInfo

Parameter

Type

Description

req_method

String

Request method.

req_uri

String

Access address of the API.

match_mode

String

Match mode of an API.

  • SWA: prefix match

  • NORMAL: exact match (default) The default value is NORMAL.

duplicated_apis

Array of DuplicateApiInfo objects

List of conflicting APIs in the path.
Table 6 DuplicateApiInfo

Parameter

Type

Description

api_id

String

API ID

api_name

String

API name.

group_name

String

Group name.

group_id

String

API group ID.

remark

String

API description.

api_type

String

API type.

  • self-owned: self-owned API

  • authorized: authorized API

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 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"
    } ]
  } ]
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

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

Status code: 404

Not Found

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

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.