PrevNext
search by keyword

Recent Pages

Documentation
API Gateway
    Documentation
    Download PDF

    AttachPlugin

    Last updated: 2021-08-17 15:23:03
    Download PDF

    1. API Description

    Domain name for API request: apigateway.tencentcloudapi.com.

    This API is used to bind a plugin to an API.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: AttachPlugin.
    Version Yes String Common parameter. The value used for this API: 2018-08-08.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    PluginId Yes String ID of the plugin to be bound
    ServiceId Yes String Service ID
    EnvironmentName Yes String API environment
    ApiIds.N Yes Array of String List of APIs bound with the plugin

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether binding succeeded.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 AttachPlugin

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=AttachPlugin
&ServiceId=Service-3fasdgrg
&PluginId=Plugin-3datbg1f
&EnvironmentName=release
&ApiIds.0=api-gesv1rfa
&ApiIds.1=api-9ads3g
&<Common request parameters>

    Output Example

    {
  "Response": {
    "Result": true,
    "RequestId": "bb85842c-c0d2-4543-8f4d-396a193babe8"
  }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.ServiceError Service error.
    FailedOperation.ServiceInOperation The service is in use. Please try again later.
    InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
    InvalidParameterValue.InvalidEnvStatus Invalid service environment status
    InvalidParameterValue.LimitExceeded The number of parameters has reached the limit (100).
    LimitExceeded.ServiceCountForPluginLimitExceeded Too many services are bound to the plugin. Unbind some services or increase the quota, and try again.
    ResourceNotFound.InvalidApi Incorrect ApiId.
    ResourceNotFound.InvalidPlugin The plugin does not exist.
    UnauthorizedOperation.AccessResource You do not have permission to access the resource.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy