Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to query the details of a usage plan, such as its name, QPS, creation time, and bound environment.
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: DescribeUsagePlan. |
| 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 queried. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | UsagePlanInfo | Usage plan details. 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=DescribeUsagePlan
&UsagePlanId=usagePlan-bxtnltfd
&<Common request parameters>{
"Response": {
"Result": {
"UsagePlanId": "usagePlan-bxtnltfd",
"UsagePlanName": "xx",
"UsagePlanDesc": null,
"InitQuota": null,
"MaxRequestNumPreSec": null,
"MaxRequestNum": null,
"IsHide": null,
"CreatedTime": "2020-02-26T14:19:52Z",
"ModifiedTime": "2020-02-26T14:25:30Z",
"BindSecretIdTotalCount": 0,
"BindSecretIds": [],
"BindEnvironmentTotalCount": 0,
"BindEnvironments": []
},
"RequestId": "e61705f3-e88a-4311-ada3-526bad10f7ab"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
|---|---|
| ResourceNotFound.InvalidUsagePlan | The usage plan does not exist. |
Was this page helpful?