Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to bind a usage plan to a service or API.
After you publish a service to an environment, if the API requires authentication and can be called only when it is bound to a usage plan, you can use this API to bind a usage plan to the specified environment.
Currently, a usage plan can be bound to an API; however, under the same service, usage plans bound to a service and usage plans bound to an API cannot coexist. Therefore, in an environment to which a service-level usage plan has already been bound, please use the DemoteServiceUsagePlan API to degrade it.
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
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: BindEnvironment. |
| 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. |
| UsagePlanIds.N | Yes | Array of String | List of unique IDs of the usage plans to be bound. |
| BindType | Yes | String | Binding type. Valid values: API, SERVICE. Default value: SERVICE. |
| Environment | Yes | String | Environment to be bound. |
| ServiceId | Yes | String | Unique ID of the service to be bound. |
| ApiIds.N | No | Array of String | Unique API ID array, which is required if bindType is API. |
| 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. |
https://apigateway.tencentcloudapi.com/?Action=BindEnvironment
&BindType=SERVICE
&Environment=test
&ServiceId=service-ody35h5e
&UsagePlanIds.0=usagePlan-quqxvett
&<Common request parameters>{
"Response": {
"Result": true,
"RequestId": "a6c567f9-7a55-43b9-81d2-f721da5e271a"
}
}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. |
| InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| LimitExceeded.RequestLimitExceeded | The request frequency has reached the limit. Please try again later. |
| ResourceNotFound.InvalidApi | Incorrect ApiId. |
| ResourceNotFound.InvalidUsagePlan | The usage plan does not exist. |
| UnsupportedOperation.UnsupportedBindEnvironment | The environment cannot be bound. |
| UnsupportedOperation.UnsupportedUnBindEnvironment | The environment cannot be unbound, as there are APIs that are not bound to a usage plan. |
Was this page helpful?