Help Center/ API Gateway/ API Reference (Kuala Lumpur Region)/ Dedicated Gateway APIs (V2)/ Plug-in Management/ Querying APIs to Which a Plug-in Can Be Bound
Updated on 2024-08-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying APIs to Which a Plug-in Can Be Bound

Function

This API is used to query the APIs to which a plug-in can be bound.

  • Pagination query

  • Fuzzy query by API name

  • APIs already bound with other plug-ins will also be returned.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attachable-apis

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

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 value is less than 0, it is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

Minimum: 1

Maximum: 500

Default: 20

env_id

Yes

String

Environment ID.

api_name

No

String

API name.

api_id

No

String

API ID.

group_id

No

String

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. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

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

APIs bound to 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 these special characters are allowed: -_./:()

type

Integer

API type.

  • 1: Public API.

  • 2: Private API.

Enumeration values:

  • 1

  • 2

req_protocol

String

API request protocol.

  • HTTP

  • HTTPS

  • BOTH: Both HTTP and HTTPS are supported.

Default: HTTPS

Enumeration values:

  • HTTP

  • HTTPS

  • BOTH

req_method

String

Request method.

Enumeration values:

  • GET

  • POST

  • PUT

  • DELETE

  • HEAD

  • PATCH

  • OPTIONS

  • ANY

req_uri

String

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

NOTE:

The address must comply with the URI specifications.

auth_type

String

API authentication mode.

  • NONE

  • APP

  • IAM

  • AUTHORIZER

Enumeration values:

  • NONE

  • APP

  • IAM

  • AUTHORIZER

match_mode

String

API matching mode.

  • SWA: Prefix match.

  • NORMAL: Exact match.

Default value: NORMAL

Enumeration values:

  • SWA

  • 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 for ROMA instances. This parameter can be left blank.

env_id

String

ID of the environment for binding to the API.

env_name

String

Name of the environment for binding to the API.

publish_id

String

Publishing record ID.

plugin_attach_id

String

Plug-in binding record ID.

attached_time

String

Binding time.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "size" : 1,
  "apis" : [ {
    "api_id" : "8aa097b00e9843efabc9c593d11b769d",
    "api_name" : "Test_API",
    "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" : "",
    "plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
    "publish_id" : "4739b3s5b729aa2237ef0d66dc635276",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "env_name" : "RELEASE",
    "attached_time" : "2020-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