Retrieves a list of plug-in attachments.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
apig:ListPluginAttachments |
none |
*All Resource
|
None | None |
Request syntax
GET /v1/plugin-attachments HTTP/1.1Request 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). Valid values:
|
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 elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| requestId |
string |
The request ID. |
9640D776-794A-5077-9184-A247CA4B45C1 |
| code |
string |
The status code. |
Ok |
| message |
string |
The status message. |
success |
| data |
object |
The response payload. |
|
| pageNumber |
integer |
The page number. |
1 |
| pageSize |
integer |
The page size. |
10 |
| totalSize |
integer |
The total number of entries returned. |
10 |
| items |
array<object> |
The details of resource attachments. |
|
|
object |
The details of the resource attachment. |
||
| pluginAttachmentId |
string |
The ID of the resource attachment. |
pa-d0j9t5em1hkncrlo51mg |
| parentResourceInfo | ParentResourceInfo |
The parent resource metadata. |
|
| resourceInfos |
array |
The information of resource attachments. |
|
| ResourceInfo |
The information of the resource attachment. |
||
| environmentInfo | EnvironmentInfo |
The environment metadata. |
|
| enable |
boolean |
Indicates if enabled. |
true |
| pluginId |
string |
The plug-in ID. |
pl-cvu6r4um1hko3b3ti0a0 |
| pluginConfig |
string |
The plug-in configurations (Base64-encoded). |
bGltaXRfYnlfaGVhZGVyOiB4LWFwaS1rZXkKbGltaXRfa2V5czoKLSBrZXk6IGV4YW1wbGUta2V5LWEKICBxdWVyeV9wZXJfc2Vjb25kOiAxMAotIGtleTogZXhhbXBsZS1rZXktYgogIHF1ZXJ5X3Blcl9zZWNvbmQ6IDEK |
| pluginClassInfo |
PluginClassInfo |
The plug-in type metadata. |
|
| attachResourceType |
string |
The types of resource attachments.
|
GatewayRoute |
Examples
Success response
JSON format
{
"requestId": "9640D776-794A-5077-9184-A247CA4B45C1",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"pluginAttachmentId": "pa-d0j9t5em1hkncrlo51mg",
"parentResourceInfo": {
"resourceType": "",
"apiInfo": {
"httpApiId": "api-xxx",
"name": "test",
"basePath": "/v1",
"description": "",
"versionInfo": {
"enable": true,
"scheme": "Query",
"headerName": "my-version",
"queryName": "myVersion",
"version": "v1"
},
"ingressInfo": {
"sourceId": "",
"ingressClass": "",
"watchNamespace": "",
"environmentInfo": {
"environmentId": ""
},
"k8sClusterInfo": {
"clusterId": ""
},
"overrideIngressIp": true
},
"type": "Rest",
"resourceGroupId": "rg-xxx",
"enabelAuth": true,
"authConfig": {
"authType": "",
"authMode": ""
},
"gatewayId": "",
"modelCategory": "",
"protocols": [
"HTTP"
],
"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"
}
]
}
],
"aiProtocols": [
""
],
"deployConfigs": [
{
"environmentId": "env-xxx",
"backendScene": "SingleService",
"autoDeploy": true,
"gatewayId": "gw-xx",
"routeBackend": {
"scene": "Single",
"services": [
{
"serviceId": "service-cq2bmmdlhtgj***",
"name": "item-service",
"protocol": "HTTP",
"port": 0,
"weight": 49,
"version": "v1"
}
]
},
"gatewayInfo": {
"gatewayId": "",
"name": "",
"vpcInfo": {
"vpcId": "",
"name": ""
},
"engineVersion": ""
},
"mock": {
"enable": false,
"responseCode": 200,
"responseContent": ""
},
"gatewayType": "API",
"customDomainIds": [
"d-xxx"
],
"serviceConfigs": [
{
"serviceId": "svc-xxx",
"weight": 100,
"modelNamePattern": "qwen-*",
"modelName": "qwen-max",
"intentCode": "",
"match": {
"default": true,
"conditions": [
{
"type": "Query",
"key": "color",
"value": "gray",
"operator": "equal"
}
]
},
"port": 0,
"protocol": "",
"gatewayServiceId": "",
"name": "",
"version": "",
"multiServiceRouteStrategy": "",
"observabilityRouteConfig": {
"mode": "",
"rateLimit": 0,
"queueSize": 0
}
}
],
"policyConfigs": [
{
"type": "AiFallback",
"enable": true,
"aiFallbackConfig": {
"serviceConfigs": [
{
"serviceId": "",
"targetModelName": ""
}
]
},
"aiSecurityGuardConfig": {
"serviceAddress": "",
"checkRequest": true,
"checkResponse": true,
"checkRequestImage": true,
"checkResponseImage": true,
"requestCheckService": "",
"responseCheckService": "",
"requestImageCheckService": "",
"responseImageCheckService": "",
"riskAlertLevel": "",
"riskConfig": [
{
"type": "",
"level": "",
"consumerRules": {
"pattern": "",
"matchType": ""
}
}
],
"bufferLimit": 0,
"consumerRequestCheckService": [
{
"name": "",
"requestCheckService": "",
"requestImageCheckService": "",
"matchType": "",
"modalityType": ""
}
],
"consumerResponseCheckService": [
{
"name": "",
"responseCheckService": "",
"responseImageCheckService": "",
"matchType": "",
"modalityType": ""
}
],
"consumerRiskLevel": [
{
"name": "",
"matchType": "",
"type": "",
"level": ""
}
]
},
"aiTokenRateLimitConfig": {
"rules": [
{
"limitType": "",
"matchKey": "",
"matchType": "",
"matchValue": "",
"limitMode": "",
"limitValue": 0
}
],
"globalRules": [
{
"limitType": "",
"matchKey": "",
"matchType": "",
"matchValue": "",
"limitMode": "",
"limitValue": 0
}
],
"enableGlobalRules": true
},
"aiStatisticsConfig": {
"logRequestContent": true,
"logResponseContent": true
}
}
],
"customDomainInfos": [
{
"domainId": "",
"name": "",
"protocol": ""
}
],
"subDomains": [
{
"domainId": "",
"name": "",
"protocol": "",
"networkType": ""
}
]
}
],
"deployCntMap": {
"key": {
"deployedCnt": 0,
"Cnt": 0
}
},
"agentProtocols": [
""
]
}
},
"resourceInfos": [
{
"resourceType": "",
"resourceId": "",
"resourceName": "",
"resourceVersion": ""
}
],
"environmentInfo": {
"environmentId": "",
"name": "",
"alias": "",
"description": "",
"gatewayInfo": {
"gatewayId": "",
"name": "",
"vpcInfo": {
"vpcId": "",
"name": ""
},
"engineVersion": ""
},
"subDomainInfos": [
{
"domainId": "",
"name": "",
"protocol": "",
"networkType": ""
}
],
"default": true,
"createTimestamp": 0,
"updateTimestamp": 0,
"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
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.