DocsICP FilingConsole
Documentation

ListPluginAttachments

Updated at:
Copy as MD
Product
My Favorites

Queries a list of plugin attachments.

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:ListPluginAttachments

none

*All Resource

*

 None None

Request syntax

GET /v1/plugin-attachments HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
attachResourceId

string

No

The ID of the attached resource.

hr-cv2h58em1hkg7c6vt43g
attachResourceType

string

No

The type of the plugin mount target. This parameter is not yet available.

Valid values:

  • GatewayDomain :

    GatewayDomain

  • Gateway :

    Gateway

  • GatewayRoute :

    GatewayRoute

  • HttpApi :

    HttpApi

  • Operation :

    Operation

GatewayRoute
environmentId

string

No

The environment ID.

env-crlnqhtlhtgqflkqislg
pluginId

string

No

The plugin ID.

pl-ct8181um1hkiqns9f6e0
gatewayId

string

No

The gateway ID.

gw-cr79f75lhtgme744084g
pageNumber

integer

No

The page number. The default value is 1.

1
pageSize

integer

No

The number of entries per page.

10
attachResourceTypes

string

No

The types of mount targets. Separate multiple types with commas.

GatewayRoute
withParentResource

boolean

No

Specifies whether to return attachments of parent resources.

false

Response elements

Element

Type

Description

Example

object

Schema of Response

requestId

string

The request ID.

9640D776-794A-5077-9184-A247CA4B45C1
code

string

The response status code.

Ok
message

string

The response message.

success
data

object

The response data.

pageNumber

integer

The page number.

1
pageSize

integer

The number of entries per page.

10
totalSize

integer

The total number of entries.

10
items

array<object>

The item details.

object

The result object.

pluginAttachmentId

string

The plugin attachment ID.

pa-d0j9t5em1hkncrlo51mg
parentResourceInfo ParentResourceInfo

The information about the parent resource.

resourceInfos

array

The information about the attached resources.

ResourceInfo

The information about the attached resource.

environmentInfo EnvironmentInfo

The environment information.

enable

boolean

Indicates whether the plugin is enabled.

true
pluginId

string

The plugin ID.

pl-cvu6r4um1hko3b3ti0a0
pluginConfig

string

The Base64-encoded content of the original plugin configuration.

bGltaXRfYnlfaGVhZGVyOiB4LWFwaS1rZXkKbGltaXRfa2V5czoKLSBrZXk6IGV4YW1wbGUta2V5LWEKICBxdWVyeV9wZXJfc2Vjb25kOiAxMAotIGtleTogZXhhbXBsZS1rZXktYgogIHF1ZXJ5X3Blcl9zZWNvbmQ6IDEK
pluginClassInfo PluginClassInfo

The information about the plugin class.

attachResourceType

string

The type of the resource to which the plugin is attached. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, and Operation.

GatewayRoute

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.