Use the plan to bind the key

Last updated: 2020-02-21 16:34:31

PDF

Interface description

This API (BindSecretIds) is used to bind keys for usage plans.
Bind the key to a usage plan, and bind the usage plan to the environment of a service publish. The caller can use this key to call the API, in the service. You can use this API to bind the key for 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
SecretIds Yes List of String ID array of keys to be bound

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

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=BindSecretIds
&usagePlanId=usagePlan-XX
&secretIds.0=AKIDXXXXXXwEdsADQ
&secretIds.1=AKIDXXXXXXjkIjdDE

The returned results are as below:

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