Query usage plan binding environment list

Last updated: 2020-06-09 15:07:49

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new API Gateway API 3.0 which is standardized and faster.

    Interface description

    This API (DescribeUsagePlanEnvironments) is used to query the list of environments bound to a usage plan.
    After binding a usage plan to the environment, users can use this API to query the environment of all the services bound to the usage plan.

    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
    UsagePlanId Yes String Unique ID for usage plan to be queried
    Limit No Int The returned quantity. When binding an environment with multiple services, if the number returned is not configured, the default is 20.
    Offset No Int When there are multiple return values, start the query from this offset
    BindType No String Binding type, the value is API, and the default value of SERVICE, is SERVICE

    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. Return the specific cause of the business error when a Success, error is returned on success.
    Message String Module error message description, related to interface
    TotalCount Int Number of environments for bound services
    EnvironmentList List of Array The environmental status of the services that have been bound to the usage plan

    EnvironmentList indicates whether the service is bound to various environments. EnvironmentList is an array of environment. Environment is composed as follows:

    Parameter name Type Description
    SeviceId String Unique ID of the bound service
    ServiceName String Name of the bound service
    EnvironmentName String Name of the environment that has been bound
    ApiId String API unique ID, returns this parameter when entering the parameter bindType=API
    InUseRequestNum Int Quota already used
    MaxRequestNum Int Total quota requested.-1 means there is no limit.

    Example

    https://apigateway.api.qcloud.com/v2/index.php?
    &<Common request parameters>
    &Action=DescribeUsagePlanEnvironments
    &usagePlanId=usagePlan-XX

    The returned results are as below:

    {
        "code": "0",
        "message": "",
        "codeDesc": "Success",
        "totalCount": 2,
        "environmentList": [{
                "seviceId": "sevice-XX",
                "serviceName": "xxx",
                "environmentName": "Test",
                "inUseRequestNum": 0,
                "maxRequestNum": -1
    
            },
            {
                "seviceId": "sevice-XXXX",
                "serviceName": "xxx",
                "environmentName": "release",
                "inUseRequestNum": 10,
                "maxRequestNum": 100
            }
        ]
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help