Help & DocumentationAPIsAPI GatewayUsage Plan APIsFrom the service environment Unbind use plan

From the service environment Unbind use plan

Last updated: 2020-02-21 16:33:59

Interface description

This API (UnBindEnvironment) is used to transfer usage plans from a specific environment, Unbind.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters .

Parameter name Required Type Description
UsagePlanIds.n Yes List Of String Unique ID list of usage plans to be bound.
ServiceId Yes String The only service waiting for Unbind is ID.
Environment Yes String The service environment waiting for Unbind.
BindType No String Binding type, the value is API, and the default value of SERVICE, is SERVICE.
ApiIds.n No List of String API unique ID array, which is required when bindType=API.

Output Parameter

Parameter name Type Description
Code Int Common error code, 0 indicates success, other values indicate failure. For more information, please see the error code page Common error code .
CodeDesc String Error code on the business side. If a Success, error is returned on success, the cause of the business error is returned.
Message String Module error message description, related to the interface.

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=UnBindEnvironment
&usagePlanId.0=usagePlan-XX
&usagePlanId.1=usagePlan-XXX
&serviceId=sevice-XX
&environment=test

The returned results are as below:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success"     
}
https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=UnBindEnvironment
&usagePlanId.0=usagePlan-XX
&usagePlanId.1=usagePlan-XXX
&serviceId=sevice-XX
&apiIds.0=api-2yuua008
&bindType=API
&environment=test

The returned results are as below:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success"      
}