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.
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 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 |
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. |
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>
{
"Response": {
"Result": true,
"RequestId": "bb85842c-c0d2-4543-8f4d-396a193babe8"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
InvalidParameter.DuplicatePluginConfig | The plugin you want to bound conflicts with existing plugins. |
InvalidParameter.FormatError | Incorrect parameter format. |
InvalidParameterValue.InvalidEnvStatus | Invalid service environment status |
InvalidParameterValue.InvalidServiceConfig | Invalid service configuration. |
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. |
UnsupportedOperation.AttachPlugin | The current plugin cannot be bound. |
UnsupportedOperation.InvalidEndpointType | Backend type not supported |
Was this page helpful?