tencent cloud

All product documents
API Gateway
DocumentationAPI GatewayAPI DocumentationAPI Category
API Category
Download PDF
Last updated: 2025-03-11 19:59:59
API Category
Last updated: 2025-03-11 19:59:59
Download PDF

Plugin APIs

API Name Feature Frequency Limit (maximum requests per second)
AttachPlugin Binds a plugin to an API 20
CreatePlugin Creates a plugin 20
DeletePlugin Deletes a plugin 20
DescribeAllPluginApis Lists all APIs that can use this plugin 20
DescribePlugin Queries details of a plugin 20
DescribePluginApis Queries APIs bound with a plugin 20
DescribePluginsByApi Queries all plug-ins bound with the API. 20
DetachPlugin Unbinds an API from a plugin 20
ModifyPlugin Modifies a plugin 20

Application APIs

API Name Feature Frequency Limit (maximum requests per second)
BindApiApp Binds application to API 20
CreateApiApp Creates application 20
DeleteApiApp Deletes application 20
DescribeApiApp Searches for application 20
DescribeApiAppBindApisStatus Queries the list of APIs bound to application 20
DescribeApiAppsStatus Queries application list 20
DescribeApiBindApiAppsStatus Queries the list of applications bound to API 20
DescribeApiForApiApp Queries API details 20
DescribeServiceForApiApp Queries service details 20
ModifyApiApp Modifies application 20
UnbindApiApp Unbinds application from API 20
UpdateApiAppKey Updates an application key 20

Other APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeInstancesNetworkConfig Retrieve the network configuration of a dedicated instance 10000
CreateUpstream Creates an upstream 20
DeleteUpstream Deletes an upstream 20
DescribeUpstreamBindApis Queries APIs bound with an upstream 20
DescribeUpstreams Queries details of upstreams under the current account 20
ModifyUpstream Modifies an upstream 20
DescribeExclusiveInstanceRegions Obtains the list of regions supported by dedicated instances 20

Usage Plan APIs

API Name Feature Frequency Limit (maximum requests per second)
BindEnvironment Binds usage plan to service or API 20
BindSecretIds Binds key to usage plan 20
CreateUsagePlan Creates usage plan 20
DeleteUsagePlan Deletes a usage plan 20
DemoteServiceUsagePlan Demotes usage plan at service level 20
DescribeUsagePlan Queries usage plan details 20
DescribeUsagePlanEnvironments Queries the list of environments bound to usage plan 20
DescribeUsagePlanSecretIds Queries the list of keys bound to usage plan 20
DescribeUsagePlansStatus Queries usage plan list 20
ModifyUsagePlan Modifies usage plan 20
UnBindEnvironment Unbinds usage plan from service environment 20
UnBindSecretIds Unbinds key from usage plan 20

IP Policy APIs

API Name Feature Frequency Limit (maximum requests per second)
BindIPStrategy Binds IP policy to API 20
CreateIPStrategy Creates service IP policy 20
DeleteIPStrategy Deletes service IP policy 20
DescribeIPStrategy Queries IP policy details 20
DescribeIPStrategyApisStatus Queries the list of APIs bound to IP policy 20
DescribeIPStrategysStatus Queries service IP policy list 20
ModifyIPStrategy Modifies service IP policy 20
UnBindIPStrategy Unbinds IP policy from service 20

Custom Domain Name APIs

API Name Feature Frequency Limit (maximum requests per second)
BindSubDomain Binds custom domain name to service 20
DeleteServiceSubDomainMapping Deletes the path mapping of custom domain name 20
DescribeServiceSubDomainMappings Queries the path mappings of custom domain name 20
DescribeServiceSubDomains Queries custom domain name list 20
ModifySubDomain Modifies the custom domain name of service 20
UnBindSubDomain Unbinds custom domain name from service 20

API Document APIs

API Name Feature Frequency Limit (maximum requests per second)
BuildAPIDoc Builds API document 20
CreateAPIDoc Creates API document 20
DeleteAPIDoc Deletes API document 20
DescribeAPIDocDetail Queries the details of API document 20
DescribeAPIDocs Queries the list of API documents 20
ModifyAPIDoc Modifies API document 20
ResetAPIDocPassword Resets the password of API document 20

OpenAPI APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateApi Creates API 20
DeleteApi Deletes API 20
DescribeApi Queries API details 100
DescribeApiUsagePlan Queries the details of API usage plans 20
DescribeApisStatus Queries API list 20
ImportOpenApi Imports OpenAPI 20
ModifyApi Modifies API 20
ModifyApiIncrement Updates API incrementally 20

Key APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateApiKey Creates key 20
DeleteApiKey Deletes key 20
DescribeApiKey Queries key details 20
DescribeApiKeysStatus Queries key list 20
DisableApiKey Disables key 20
EnableApiKey Enables key 20
UpdateApiKey Updates key 20

Log APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeLogSearch Searches for logs 20

Service APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateService Creates service 20
DeleteService Deletes service 20
DescribeService Queries service details 20
DescribeServiceEnvironmentList Queries service environment list 20
DescribeServiceEnvironmentReleaseHistory Queries release history in service environment 20
DescribeServiceReleaseVersion Queries the published versions of service 20
DescribeServiceUsagePlan Queries the usage plan details of service 20
DescribeServicesStatus Queries service status 20
ModifyService Modifies service 20
ReleaseService Publishes service 20
UnReleaseService Deactivates service 20
UpdateService Updates service version 20

Throttling Policy APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeApiEnvironmentStrategy Displays throttling policies bound to API 20
DescribeServiceEnvironmentStrategy Displays service throttling policy 20
ModifyApiEnvironmentStrategy Modifies API throttling policy 20
ModifyServiceEnvironmentStrategy Modifies service throttling policy 20
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon