Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Plug-in Management/ Querying APIs Bound with a Plug-in
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying APIs Bound with a Plug-in

Function

Query APIs bound with a plug-in.

  • Query the list of APIs bound to a plug-in.

  • Support query pagination.

  • Support fuzzy query by API name.

  • The APIs returned in the binding relationship list may have been taken offline from the corresponding environment.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/plugins/{plugin_id}/attached-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.

plugin_id

Yes

String

Plug-in ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

env_id

No

String

ID of the environment the API has been published in.

api_name

No

String

API name.

api_id

No

String

API ID.

group_id

No

String

API group ID.

req_method

No

String

Request method.

req_uri

No

String

Request path.

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 PluginApiInfo objects

Bound APIs with the plug-in.
Table 5 PluginApiInfo

Parameter

Type

Description

api_id

String

API ID.

api_name

String

API name.

Enter 3 to 255 characters, starting with a letter or digit. Only letters, digits, and the following special characters are allowed: -_./:()

type

Integer

API types. The options are as follows:

  • 1: public APIs

  • 2: private APIs

req_protocol

String

API request protocol.

  • HTTP

  • HTTPS

  • BOTH: Both HTTP and HTTPS are supported.

Default: HTTPS

req_method

String

Request method.

req_uri

String

Request URI. The value can contain request parameters identified by braces ({}), for example, /getUserInfo/{userId}. Special characters such as * / / %- _ . are supported. The total length cannot exceed 512 characters and must meet the URI specifications.

Environment variables are supported. If environment variables are used, each variable name is a string of 3 to 32 characters. The string consists of letters, digits, hyphens (-), and underscores (_) and must start with an English letter.

NOTE:

The value must comply with the URI specifications.

auth_type

String

API authentication mode. The options are as follows:

  • NONE

  • APP

  • IAM

  • AUTHORIZER (custom)

match_mode

String

Match mode of an API.

  • SWA: prefix match

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

remark

String

API description.

group_id

String

ID of the API group to which the API belongs.

group_name

String

Name of the API group to which the API belongs.

roma_app_id

String

Integration application ID.

env_id

String

ID of the environment for API calling authorization.

env_name

String

Name of the environment for API calling authorization.

publish_id

String

Publish ID.

plugin_attach_id

String

Plug-in binding ID.

attached_time

String

Time when the API is bound.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 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" : [ {
    "api_id" : "8aa097b00e9843efabc9c593d11b769d",
    "api_name" : "API name.",
    "type" : 1,
    "req_protocol" : "HTTP",
    "req_method" : "GET",
    "req_uri" : "/test",
    "auth_type" : "IAM",
    "match_mode" : "NORMAL",
    "remark" : "API description.",
    "group_id" : "b9be707660c5406394f8973e087bae20",
    "group_name" : "DEFAULT",
    "roma_app_id" : "82a9a3c3-781f-440a-ae4b-fb0cc88e22c8",
    "plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
    "publish_id" : "4739b3s5b729aa2237ef0d66dc635276",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "env_name" : "RELEASE",
    "attached_time" : "2022-11-02T12:31:23.353Z"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. 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.3068",
  "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 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.

Parent topic: Plug-in Management