DocsICP FilingConsole
Documentation

ListInstallableGateways

Updated at:
Copy as MD
Product
My Favorites

Retrieves gateways on which a plugin can be installed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:ListInstallableGateways

none

*All Resource

*

 None None

Request syntax

GET /v1/plugin-classes/{pluginClassId}/installable-gateways HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example
pluginClassId

string

No

The plugin class ID. This is a path parameter and cannot be empty. The plugin class must exist.

pc-xxxx

Request parameters

Parameter

Type

Required

Description

Example
pageNumber

integer

No

The page number.

1
pageSize

integer

No

The number of entries per page.

10
gatewayType

string

No

The gateway type used for filtering.

Valid values:

  • AI :

    AI gateway.

  • API :

    API gateway (default)

AI

Response elements

Element

Type

Description

Example

object

Schema of Response

requestId

string

Id of the request

019FA163-3664-5D34-81D1-5FFFC94AD7D5
code

string

The response status code.

200
message

string

The response message.

success
data

object

The response data.

pageNumber

string

The page number.

1
pageSize

string

The page size.

10
totalSize

string

The total number of entries.

43
items

array<object>

The list of gateways.

object

The list of gateways.

gatewayId

string

The gateway ID.

gw-xxxx
name

string

The gateway name.

my-gateway
installable

boolean

Indicates whether the plugin can be installed on the gateway.

true
engineVersion

string

The database engine version of the gateway DPI engine.

2.1.10
gatewayPhase

string

The gateway status. The value is passed through from the GatewayPhase enumeration, such as Running or Creating.

Running
installableFalseReasonType

string

The reason why the plugin cannot be installed.

Valid values:

  • GATEWAY_NOT_RUNNING :

    The gateway is not in the Running state.

  • MULTI_TENANT_NOT_SUPPORTED :

    The plugin class is hidden for multi-tenant gateways, so the gateway is grayed out.

  • VERSION_NOT_MATCH :

    The current database engine version of the gateway DPI engine is earlier than the minimum version required by the plugin (supportedMinGatewayVersion).

  • INSTALLED_OTHER_VERSION :

    Another version of the same plugin is already installed on the gateway. The installedPluginVersion field is returned.

  • UNSUPPORTED_PLUGIN :

    The multi-tenant Serverless gateway does not support this plugin. Only platform plugins can be installed. Legacy custom Wasm/Lua plugins that are not disguised as platform plugins cannot be installed.

VERSION_NOT_MATCH
installedPluginVersion

string

The version number of another version of the same plugin class that is already installed on the gateway.

1.0.0

Examples

Success response

JSON format

{
  "requestId": "019FA163-3664-5D34-81D1-5FFFC94AD7D5",
  "code": "200",
  "message": "success",
  "data": {
    "pageNumber": "1",
    "pageSize": "10",
    "totalSize": "43",
    "items": [
      {
        "gatewayId": "gw-xxxx",
        "name": "my-gateway",
        "installable": true,
        "engineVersion": "2.1.10",
        "gatewayPhase": "Running",
        "installableFalseReasonType": "VERSION_NOT_MATCH",
        "installedPluginVersion": "1.0.0"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.