BindApiApp

Last updated: 2021-08-17 15:23:11

1. API Description

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

This API is used to bind an application 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: BindApiApp.
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.
ApiAppId Yes String Unique ID of the application to be bound.
Environment Yes String Environment to be bound.
ServiceId Yes String Unique ID of the service to be bound.
ApiId Yes String Unique ID of the API to be bound.

3. Output Parameters

Parameter Name Type Description
Result Boolean Whether binding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 BindApiApp

Input Example

https://apigateway.tencentcloudapi.com/?Action=BindApiApp
&ApiAppId=app-kzofrjbl
&Environment=test
&ServiceId=service-ody35h5e
&ApiId=api-c6piso8y
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": true,
    "RequestId": "a6c567f9-7a55-43b9-81d2-f721da5e271a"
  }
}

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.ApiError API error.
FailedOperation.ApiInOperation The API is being manipulated. Please try again later.
FailedOperation.ServiceInOperation The service is in use. Please try again later.
InternalError.ApigwException API Gateway internal request error. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InvalidParameterValue.InvalidEnv The value of the Env parameter is incorrect. Its valid values are (release, prepub, test).
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidApiApp The application ID is incorrect.
UnsupportedOperation.ResourceAssociated The resource has been associated. Please disassociate it first.
UnsupportedOperation.UnsupportedBindEnvironment The environment cannot be bound.