Retrieves a list of plug-in attachments.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| apig:ListPluginAttachments | none | *All Resources * |
| none |
Request syntax
GET /v1/plugin-attachments HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| attachResourceId | string | No | The resource attachment ID. | hr-cv2h58em1hkg7c6vt43g |
| attachResourceType | string | No | The resource attachment type (not yet in use). Enumeration Value:
| GatewayRoute |
| environmentId | string | No | The environment ID. | env-crlnqhtlhtgqflkqislg |
| pluginId | string | No | The plug-in ID. | pl-ct8181um1hkiqns9f6e0 |
| gatewayId | string | No | The gateway ID. | gw-cr79f75lhtgme744084g |
| pageNumber | integer | No | The page number to return. Pages start from 1. Default value: 1. | 1 |
| pageSize | integer | No | The number of entries per page. Default value: 10. | 10 |
| attachResourceTypes | string | No | The resource attachment types, separated by commas. | GatewayRoute |
| withParentResource | boolean | No | Specifies whether to return parent resource attachments. | false |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "9640D776-794A-5077-9184-A247CA4B45C1",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"pluginAttachmentId": "pa-d0j9t5em1hkncrlo51mg",
"parentResourceInfo": {
"resourceType": "Gateway",
"apiInfo": {
"httpApiId": "api-xxx",
"name": "test",
"protocols": [
"HTTP"
],
"basePath": "/v1",
"description": "for test only",
"versionInfo": {
"enable": true,
"scheme": "Query",
"headerName": "my-version",
"queryName": "myVersion",
"version": "v1"
},
"environments": [
{
"environmentId": "env-xxx",
"backendScene": "SingleService",
"backendType": "Service",
"serviceConfigs": [
{
"gatewayServiceId": "gs-xxx",
"name": "demo-service",
"protocol": "HTTP",
"port": 8080,
"weight": 100,
"version": "v1",
"match": {
"default": true,
"conditions": [
{
"type": "Query",
"key": "color",
"value": "gray",
"operator": "equal"
}
]
},
"serviceId": "svc-xxx"
}
],
"customDomains": [
{
"domainId": "d-xxx",
"name": "www.example.com",
"protocol": "HTTP"
}
],
"name": "test",
"alias": "test",
"gatewayInfo": {
"gatewayId": "gw-xxx",
"name": "test"
},
"deployStatus": "Deployed",
"subDomains": [
{
"domainId": "d-xxx",
"name": "www.example.com",
"protocol": "HTTP",
"networkType": "Internet"
}
]
}
],
"ingressInfo": {
"sourceId": "src-xxx",
"ingressClass": "mse",
"watchNamespace": "default",
"environmentInfo": {
"environmentId": "env-xxx"
},
"k8sClusterInfo": {
"clusterId": "ca435c77cba1547cca9311957bcxxxxxx"
},
"overrideIngressIp": true
},
"type": "Rest",
"resourceGroupId": "rg-xxx",
"aiProtocols": [
"OpenAI/v1"
],
"deployConfigs": [
{
"customDomainIds": [
"d-xxx"
],
"environmentId": "env-xxx",
"backendScene": "SingleService",
"serviceConfigs": [
{
"serviceId": "svc-xxx",
"weight": 100,
"modelNamePattern": "qwen-*",
"modelName": "qwen-max"
}
],
"policyConfigs": [
{
"type": "AiFallback",
"enable": true,
"aiFallbackConfig": {
"serviceIds": [
"svc-xxx"
]
}
}
],
"autoDeploy": true
}
],
"enabelAuth": true,
"authConfig": {
"authType": "Jwt",
"authMode": "NoAuth"
}
}
},
"resourceInfos": [
{
"resourceType": "HttpApi",
"resourceId": "api-1nsu2d****",
"resourceName": "test1023",
"resourceVersion": "1.0.0"
}
],
"environmentInfo": {
"environmentId": "env-cq7l5s5lhtgi6qasrdc0",
"name": "test",
"alias": "test-env",
"description": "This is a test environment.",
"gatewayInfo": {
"gatewayId": "gw-cq7og15lhtgi6qasrj60",
"name": "apitest-gw",
"vpcInfo": {
"vpcId": "vpc-uf664nyle5kh***",
"name": "test-vpc"
},
"engineVersion": "2.0.7"
},
"subDomainInfos": [
{
"domainId": "d-cpudb0llhtgl2djvq2sg",
"name": "abc.com",
"protocol": "HTTP",
"networkType": "Intranet"
}
],
"default": false,
"createTimestamp": 1721116090326,
"updateTimestamp": 1721116090326,
"resourceGroupId": "rg-xxxx"
},
"enable": true,
"pluginId": "pl-cvu6r4um1hko3b3ti0a0",
"pluginConfig": "bGltaXRfYnlfaGVhZGVyOiB4LWFwaS1rZXkKbGltaXRfa2V5czoKLSBrZXk6IGV4YW1wbGUta2V5LWEKICBxdWVyeV9wZXJfc2Vjb25kOiAxMAotIGtleTogZXhhbXBsZS1rZXktYgogIHF1ZXJ5X3Blcl9zZWNvbmQ6IDEK",
"pluginClassInfo": {
"pluginClassId": "",
"type": "",
"mode": "",
"name": "",
"alias": "",
"description": "",
"source": "",
"version": "",
"versionDescription": "",
"executeStage": "",
"executePriority": 0,
"configExample": "",
"imageName": "",
"wasmLanguage": "",
"supportedMinGatewayVersion": "",
"wasmUrl": "",
"innerPlugin": true
},
"attachResourceType": "GatewayRoute"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.