All Products
Search
Document Center

API Gateway:GetPluginAttachment

Last Updated:Dec 17, 2025

Queries a plug-in attachment.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:GetPluginAttachmentget
*All Resources
*
    none
none

Request syntax

GET /v1/plugin-attachments/{pluginAttachmentId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
pluginAttachmentIdstringNo

The attachment ID.

pa-cvl541em1hkk7n8vq810

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The ID of the request.

C61E30D3-579A-5B43-994E-31E02EDC9129
codestring

The status code.

Ok
messagestring

The status message.

success
dataobject

The response payload.

pluginAttachmentIdstring

The attachment ID.

pa-d05f1tmm1hku195dd8j0
parentResourceInfoParentResourceInfo

The information about the parent resource to which the plug-in is attached.

resourceInfosarray

The resource details.

itemResourceInfo

The resource information.

environmentInfoEnvironmentInfo

The environment information.

pluginConfigstring

The Base64-encoded configurations of the plug-in.

cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K
enableboolean

Indicates whether the plug-in is enabled.

true
pluginIdstring

The plug-in ID.

pl-cvo8ub6m1hkvgv03r3k0
pluginClassInfoPluginClassInfo

The plug-in type information.

gatewayInfoGatewayInfo

The instance information.

Examples

Sample success responses

JSONformat

{
  "requestId": "C61E30D3-579A-5B43-994E-31E02EDC9129",
  "code": "Ok",
  "message": "success",
  "data": {
    "pluginAttachmentId": "pa-d05f1tmm1hku195dd8j0",
    "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"
    },
    "pluginConfig": "cHJlcGVuZDoKLSByb2xlOiBzeXN0ZW0KICBjb250ZW50OiDor7fkvb/nlKjoi7Hor63lm57nrZTpl67popgKYXBwZW5kOgotIHJvbGU6IHVzZXIKICBjb250ZW50OiDmr4/mrKHlm57nrZTlrozpl67popjvvIzlsJ3or5Xov5vooYzlj43pl64K",
    "enable": true,
    "pluginId": "pl-cvo8ub6m1hkvgv03r3k0",
    "pluginClassInfo": {
      "pluginClassId": "",
      "type": "",
      "mode": "",
      "name": "",
      "alias": "",
      "description": "",
      "source": "",
      "version": "",
      "versionDescription": "",
      "executeStage": "",
      "executePriority": 0,
      "configExample": "",
      "imageName": "",
      "wasmLanguage": "",
      "supportedMinGatewayVersion": "",
      "wasmUrl": "",
      "innerPlugin": true
    },
    "gatewayInfo": {
      "gatewayId": "gw-cq7og15lhtgi6qasrj60",
      "name": "apitest-gw",
      "vpcInfo": {
        "vpcId": "vpc-uf664nyle5kh***",
        "name": "test-vpc"
      },
      "engineVersion": "2.0.7"
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.