Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to bind a key to a usage plan.
You can bind a key to a usage plan and bind the usage plan to an environment where a service is published, so that callers can use the key to call APIs in the service. You can use this API to bind a key to a usage plan.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
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: BindSecretIds. |
| 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. |
| UsagePlanId | Yes | String | Unique ID of the usage plan to be bound. |
| AccessKeyIds.N | Yes | Array of String | Array of IDs of the keys to be bound. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | Boolean | Whether binding 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. |
https://apigateway.tencentcloudapi.com/?Action=BindSecretIds
&UsagePlanId=usagePlan-quqxvett
&AccessKeyIds.0=AKIDmyE2z0gvi2p6i9lWr3bbetpTaquaxQ8s8iob
&<Common request parameters>{
"Response": {
"Result": true,
"RequestId": "fcc3e46c-931d-4c58-88e9-f3cfc2251769"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
| ResourceNotFound.InvalidAccessKeyId | The key does not exist. |
| ResourceNotFound.InvalidUsagePlan | The usage plan does not exist. |
| UnsupportedOperation.AlreadyBindUsagePlan | The key has already been bound to a usage plan. |
| UnsupportedOperation.UnsupportedBindApiKey | The key has already been bound to a usage plan. |
Was this page helpful?