tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

AttachPlugin

最后更新时间：2024-11-14 22:10:29

    1. API Description

    Domain name for API request: apigateway.intl.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.

    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 Params. The value used for this API: AttachPlugin.
    Version Yes String Common Params. The value used for this API: 2018-08-08.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    PluginId Yes String ID of the bound API gateway plugin.
    ServiceId Yes String ID of the service to be operated.
    EnvironmentName Yes String Environment for operating the API.
    ApiIds.N Yes Array of String List of APIs to be bound.

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether the binding operation is successful.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 AttachPlugin

    Input Example

    https://apigateway.intl.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.InvalidInputJSON
    FailedOperation.ServiceError Service error.
    FailedOperation.ServiceInOperation The service is in use. Please try again later.
    FailedOperation.TaskAlreadyExist
    InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
    InternalError.ReturnableException
    InvalidParameter.DuplicatePluginConfig The plugin you want to bound conflicts with existing plugins.
    InvalidParameter.FormatError Incorrect parameter format.
    InvalidParameterValue.DuplicatePluginConfig Duplicate plugin parameter values. Please modify and try again.
    InvalidParameterValue.InvalidEnvStatus Invalid service environment status
    InvalidParameterValue.InvalidServiceConfig Invalid service configuration.
    InvalidParameterValue.LimitExceeded The number of parameters has reached the limit (100).
    InvalidParameterValue.TrafficControl
    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.
    ResourceNotFound.InvalidService The corresponding service is invisible.
    UnauthorizedOperation.AccessResource You do not have permission to access the resource.
    UnsupportedOperation.AttachPlugin The current plugin cannot be bound.
    UnsupportedOperation.BasicServiceNotAllowAttachPlugin
    UnsupportedOperation.InvalidEndpointType Backend type not supported
    UnsupportedOperation.UnpackError
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款