Query the list of usage plan binding keys

Last updated: 2020-02-21 16:37:53

    Interface description

    This API (DescribeUsagePlanSecretIds) is used to query the list of keys bound to the usage plan.
    In the API gateway, multiple key pairs can be bound to a usage plan. You can use this API to query the list of keys 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 of the usage plan to be bound
    Limit No Int The returned quantity
    Offset No Int Offset (from which key pair to start the query)

    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 String Number of keys
    SecretIdList List of Array List of key details

    SecretIdList is a list of secretStatus, where secretStatus is composed as follows:

    Parameter name Type Description
    SecretName String Key Name
    SecretID String Key ID
    Status Int Key status. 0: disabled, 1: enabled

    Example

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

    The returned results are as below:

    {
        "code": "0",
        "message": "",
        "codeDesc": "Success",
        "totalCount": 2,
        "secretIdList": [{
                "secretName": "hwpwolmy",
                "secretId": "AKIDckpbbu0uogyngvbjuhn3z1mbqfy1db7h2cs9",
                "status": 1
            },
            {
                "secretName": "8jsuxt2i",
                "secretId": "AKIDFD3ZD5rq48TQKH61Lh6l37m0w507rD3h79z",
                "status": 0
            }
        ]
    }

    Was this page helpful?

    Was this page helpful?

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