UnBindEnvironment

Prev Next

search by keyword

Recent Pages

Documentation

Last updated: 2021-12-03 10:27:44

1. API Description

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

This API is used to unbind a usage plan from a specified environment.

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 parameter. The value used for this API: UnBindEnvironment.
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.
BindType	Yes	String	Binding type. Valid values: API, SERVICE. Default value: SERVICE.
UsagePlanIds.N	Yes	Array of String	List of unique IDs of the usage plans to be bound.
Environment	Yes	String	Service environment to be unbound.
ServiceId	Yes	String	Unique ID of the service to be unbound.
ApiIds.N	No	Array of String	Unique API ID array, which is required if `BindType` is `API`.

3. Output Parameters

Parameter Name	Type	Description
Result	Boolean	Whether unbinding 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 Unbinding usage plan

Input Example

https://apigateway.tencentcloudapi.com/?Action=UnBindEnvironment
&BindType=SERVICE
&Environment=test
&ServiceId=service-ody35h5e
&UsagePlanIds.0=usagePlan-quqxvett
&<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

Tencent Cloud CLI 3.0

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.
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.
InvalidParameterValue.InvalidRegion	Incorrect region.
ResourceNotFound.InvalidApi	Incorrect `ApiId`.
ResourceNotFound.InvalidService	The corresponding service is invisible.
ResourceNotFound.InvalidUsagePlan	The usage plan does not exist.
UnsupportedOperation.UnsupportedUnBindEnvironment	The environment cannot be unbound, as there are APIs that are not bound to a usage plan.

Recent Pages