com.tencentcloudapi.apigateway.v20180808

Class ApigatewayClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.apigateway.v20180808.ApigatewayClient

public class ApigatewayClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
ApigatewayClient(Credential credential, String region)
ApigatewayClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
AttachPluginResponse	AttachPlugin(AttachPluginRequest req) This API is used to bind a plugin to an API.
BindApiAppResponse	BindApiApp(BindApiAppRequest req) This API is used to bind an application to an API.
BindEnvironmentResponse	BindEnvironment(BindEnvironmentRequest req) This API is used to bind a usage plan to a service or API.
BindIPStrategyResponse	BindIPStrategy(BindIPStrategyRequest req) This API is used to bind an IP policy to an API.
BindSecretIdsResponse	BindSecretIds(BindSecretIdsRequest req) This API is used to bind a key to a usage plan.
BindSubDomainResponse	BindSubDomain(BindSubDomainRequest req) This API is used to bind a custom domain name to a service.
BuildAPIDocResponse	BuildAPIDoc(BuildAPIDocRequest req) This API is used to build an API document.
CreateApiResponse	CreateApi(CreateApiRequest req) This API is used to create an API.
CreateApiAppResponse	CreateApiApp(CreateApiAppRequest req) This API is used to create an application.
CreateAPIDocResponse	CreateAPIDoc(CreateAPIDocRequest req) This API is used to create an API document.
CreateApiKeyResponse	CreateApiKey(CreateApiKeyRequest req) This API is used to create an API key pair.
CreateIPStrategyResponse	CreateIPStrategy(CreateIPStrategyRequest req) This API is used to create a service IP policy.
CreatePluginResponse	CreatePlugin(CreatePluginRequest req) This API is used to create an API Gateway plugin.
CreateServiceResponse	CreateService(CreateServiceRequest req) This API is used to create a service.
CreateUpstreamResponse	CreateUpstream(CreateUpstreamRequest req) This API is used to create an upstream.
CreateUsagePlanResponse	CreateUsagePlan(CreateUsagePlanRequest req) This API is used to create a usage plan.
DeleteApiResponse	DeleteApi(DeleteApiRequest req) This API is used to delete a created API.
DeleteApiAppResponse	DeleteApiApp(DeleteApiAppRequest req) This API is used to delete a created application.
DeleteAPIDocResponse	DeleteAPIDoc(DeleteAPIDocRequest req) This API is used to delete an API document.
DeleteApiKeyResponse	DeleteApiKey(DeleteApiKeyRequest req) This API is used to delete an API key pair.
DeleteIPStrategyResponse	DeleteIPStrategy(DeleteIPStrategyRequest req) This API is used to delete a service IP policy.
DeletePluginResponse	DeletePlugin(DeletePluginRequest req) This API is used to delete an API Gateway plugin.
DeleteServiceResponse	DeleteService(DeleteServiceRequest req) This API is used to delete a service in API Gateway.
DeleteServiceSubDomainMappingResponse	DeleteServiceSubDomainMapping(DeleteServiceSubDomainMappingRequest req) This API is used to delete a custom domain name mapping in a service environment.
DeleteUpstreamResponse	DeleteUpstream(DeleteUpstreamRequest req) This API is used to delete an upstream.
DeleteUsagePlanResponse	DeleteUsagePlan(DeleteUsagePlanRequest req) This API is used to delete a usage plan.
DemoteServiceUsagePlanResponse	DemoteServiceUsagePlan(DemoteServiceUsagePlanRequest req) This API is used to degrade a usage plan of a service in an environment to the API level.
DescribeAllPluginApisResponse	DescribeAllPluginApis(DescribeAllPluginApisRequest req) This API is used to list all APIs that can use this plugin, no matter whether the API is bound with the plugin.
DescribeApiResponse	DescribeApi(DescribeApiRequest req) This API (`DescribeApi`) is used to query the details of the APIs users manage via Tencent Cloud API Gateway.
DescribeApiAppResponse	DescribeApiApp(DescribeApiAppRequest req) This API is used to search for an application by application ID.
DescribeApiAppBindApisStatusResponse	DescribeApiAppBindApisStatus(DescribeApiAppBindApisStatusRequest req) This API is used to query the list of APIs bound to an application.
DescribeApiAppsStatusResponse	DescribeApiAppsStatus(DescribeApiAppsStatusRequest req) This API is used to query the application list.
DescribeApiBindApiAppsStatusResponse	DescribeApiBindApiAppsStatus(DescribeApiBindApiAppsStatusRequest req) This API is used to query the list of applications bound to an API.
DescribeAPIDocDetailResponse	DescribeAPIDocDetail(DescribeAPIDocDetailRequest req) This API is used to query the details of an API document.
DescribeAPIDocsResponse	DescribeAPIDocs(DescribeAPIDocsRequest req) This API is used to query the list of API documents.
DescribeApiEnvironmentStrategyResponse	DescribeApiEnvironmentStrategy(DescribeApiEnvironmentStrategyRequest req) This API is used to display the throttling policies bound to an API.
DescribeApiForApiAppResponse	DescribeApiForApiApp(DescribeApiForApiAppRequest req) This API is used to query the details of an API deployed at API Gateway.
DescribeApiKeyResponse	DescribeApiKey(DescribeApiKeyRequest req) This API is used to query the details of a key.
DescribeApiKeysStatusResponse	DescribeApiKeysStatus(DescribeApiKeysStatusRequest req) This API is used to query the information of one or more API keys.
DescribeApisStatusResponse	DescribeApisStatus(DescribeApisStatusRequest req) This API is used to view a certain API or the list of all APIs under a service and relevant information.
DescribeApiUsagePlanResponse	DescribeApiUsagePlan(DescribeApiUsagePlanRequest req) This API is used to query the details of API usage plans in a service.
DescribeIPStrategyResponse	DescribeIPStrategy(DescribeIPStrategyRequest req) This API is used to query IP policy details.
DescribeIPStrategyApisStatusResponse	DescribeIPStrategyApisStatus(DescribeIPStrategyApisStatusRequest req) This API is used to query the list of APIs to which an IP policy can be bound, i.e., the difference set between all APIs under the service and the APIs already bound to the policy.
DescribeIPStrategysStatusResponse	DescribeIPStrategysStatus(DescribeIPStrategysStatusRequest req) This API is used to query the list of service IP policies.
DescribeLogSearchResponse	DescribeLogSearch(DescribeLogSearchRequest req) This API is used to search for logs.
DescribePluginResponse	DescribePlugin(DescribePluginRequest req) This API is used to query the plugin details by plugin ID.
DescribePluginApisResponse	DescribePluginApis(DescribePluginApisRequest req) This API is used to query APIs bound with a specified plugin.
DescribePluginsByApiResponse	DescribePluginsByApi(DescribePluginsByApiRequest req) This API is used to query all plug-ins bound with the API.
DescribeServiceResponse	DescribeService(DescribeServiceRequest req) This API is used to query the details of a service, such as its description, domain name, protocol, creation time, and releases.
DescribeServiceEnvironmentListResponse	DescribeServiceEnvironmentList(DescribeServiceEnvironmentListRequest req) This API is used to query the list of environments under a service.
DescribeServiceEnvironmentReleaseHistoryResponse	DescribeServiceEnvironmentReleaseHistory(DescribeServiceEnvironmentReleaseHistoryRequest req) This API is used to query the release history in a service environment.
DescribeServiceEnvironmentStrategyResponse	DescribeServiceEnvironmentStrategy(DescribeServiceEnvironmentStrategyRequest req) This API is used to display a service throttling policy.
DescribeServiceForApiAppResponse	DescribeServiceForApiApp(DescribeServiceForApiAppRequest req) This API is used to query the details of a service, such as its description, domain name, and protocol.
DescribeServiceReleaseVersionResponse	DescribeServiceReleaseVersion(DescribeServiceReleaseVersionRequest req) This API is used to query the list of all published versions under a service.
DescribeServicesStatusResponse	DescribeServicesStatus(DescribeServicesStatusRequest req) This API is used to query the list of one or more services and return relevant domain name, time, and other information.
DescribeServiceSubDomainMappingsResponse	DescribeServiceSubDomainMappings(DescribeServiceSubDomainMappingsRequest req) This API is used to query the path mappings of a custom domain name.
DescribeServiceSubDomainsResponse	DescribeServiceSubDomains(DescribeServiceSubDomainsRequest req) This API is used to query the list of custom domain names.
DescribeServiceUsagePlanResponse	DescribeServiceUsagePlan(DescribeServiceUsagePlanRequest req) This API is used to query the details of usage plans in a service.
DescribeUpstreamBindApisResponse	DescribeUpstreamBindApis(DescribeUpstreamBindApisRequest req) This API is used to query APIs bound with an upstream.
DescribeUpstreamsResponse	DescribeUpstreams(DescribeUpstreamsRequest req) This API is used to query details of upstreams under the current account.
DescribeUsagePlanResponse	DescribeUsagePlan(DescribeUsagePlanRequest req) This API is used to query the details of a usage plan, such as its name, QPS, creation time, and bound environment.
DescribeUsagePlanEnvironmentsResponse	DescribeUsagePlanEnvironments(DescribeUsagePlanEnvironmentsRequest req) This API is used to query the list of environments bound to a usage plan.
DescribeUsagePlanSecretIdsResponse	DescribeUsagePlanSecretIds(DescribeUsagePlanSecretIdsRequest req) This API is used to query the list of keys bound to a usage plan.
DescribeUsagePlansStatusResponse	DescribeUsagePlansStatus(DescribeUsagePlansStatusRequest req) This API is used to query the list of usage plans.
DetachPluginResponse	DetachPlugin(DetachPluginRequest req) This API is used to unbind an API from the plugin.
DisableApiKeyResponse	DisableApiKey(DisableApiKeyRequest req) This API is used to disable an API key.
EnableApiKeyResponse	EnableApiKey(EnableApiKeyRequest req) This API is used to enable a disabled API key.
GenerateApiDocumentResponse	GenerateApiDocument(GenerateApiDocumentRequest req) This API is used to automatically generate API documents and SDKs.
ImportOpenApiResponse	ImportOpenApi(ImportOpenApiRequest req) This API is used to import an OpenAPI to API gateway.
ModifyApiResponse	ModifyApi(ModifyApiRequest req) This API is used to modify an API.
ModifyApiAppResponse	ModifyApiApp(ModifyApiAppRequest req) This API is used to modify a created API.
ModifyAPIDocResponse	ModifyAPIDoc(ModifyAPIDocRequest req) This API is used to modify an API document.
ModifyApiEnvironmentStrategyResponse	ModifyApiEnvironmentStrategy(ModifyApiEnvironmentStrategyRequest req) This API is used to modify an API throttling policy.
ModifyApiIncrementResponse	ModifyApiIncrement(ModifyApiIncrementRequest req) This API is used to incrementally update an API and mainly called by programs (different from `ModifyApi`, which requires that full API parameters be passed in and is suitable for use in the console).
ModifyIPStrategyResponse	ModifyIPStrategy(ModifyIPStrategyRequest req) This API is used to modify a service IP policy.
ModifyPluginResponse	ModifyPlugin(ModifyPluginRequest req) This API is used to modify a plugin.
ModifyServiceResponse	ModifyService(ModifyServiceRequest req) This API is used to modify the relevant information of a service.
ModifyServiceEnvironmentStrategyResponse	ModifyServiceEnvironmentStrategy(ModifyServiceEnvironmentStrategyRequest req) This API is used to modify a service throttling policy.
ModifySubDomainResponse	ModifySubDomain(ModifySubDomainRequest req) This API is used to modify the path mapping in the custom domain name settings of a service.
ModifyUpstreamResponse	ModifyUpstream(ModifyUpstreamRequest req) This API is used to modify an upstream.
ModifyUsagePlanResponse	ModifyUsagePlan(ModifyUsagePlanRequest req) This API is used to modify the name, description, and QPS of a usage plan.
ReleaseServiceResponse	ReleaseService(ReleaseServiceRequest req) This API is used to publish a service.
ResetAPIDocPasswordResponse	ResetAPIDocPassword(ResetAPIDocPasswordRequest req) This API is used to reset the password of an API document.
UnbindApiAppResponse	UnbindApiApp(UnbindApiAppRequest req) This API is used to unbind an application from an API.
UnBindEnvironmentResponse	UnBindEnvironment(UnBindEnvironmentRequest req) This API is used to unbind a usage plan from a specified environment.
UnBindIPStrategyResponse	UnBindIPStrategy(UnBindIPStrategyRequest req) This API is used to unbind an IP policy from a service.
UnBindSecretIdsResponse	UnBindSecretIds(UnBindSecretIdsRequest req) This API is used to unbind a key from a usage plan.
UnBindSubDomainResponse	UnBindSubDomain(UnBindSubDomainRequest req) This API is used to unbind a custom domain name.
UnReleaseServiceResponse	UnReleaseService(UnReleaseServiceRequest req) This API is used to deactivate a service.
UpdateApiAppKeyResponse	UpdateApiAppKey(UpdateApiAppKeyRequest req) This API is used to update an application key.
UpdateApiKeyResponse	UpdateApiKey(UpdateApiKeyRequest req) This API is used to update a created API key pair.
UpdateServiceResponse	UpdateService(UpdateServiceRequest req) This API is used to switch the running version of a service published in an environment to a specified version.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApigatewayClient

public ApigatewayClient(Credential credential,
                        String region)

ApigatewayClient

public ApigatewayClient(Credential credential,
                        String region,
                        ClientProfile profile)

Method Detail

AttachPlugin

public AttachPluginResponse AttachPlugin(AttachPluginRequest req)
                                  throws TencentCloudSDKException

This API is used to bind a plugin to an API.

Parameters:

req - AttachPluginRequest

Returns:

AttachPluginResponse

Throws:

TencentCloudSDKException

BindApiApp

public BindApiAppResponse BindApiApp(BindApiAppRequest req)
                              throws TencentCloudSDKException

This API is used to bind an application to an API.

Parameters:

req - BindApiAppRequest

Returns:

BindApiAppResponse

Throws:

TencentCloudSDKException

BindEnvironment

public BindEnvironmentResponse BindEnvironment(BindEnvironmentRequest req)
                                        throws TencentCloudSDKException

This API is used to bind a usage plan to a service or API. After you publish a service to an environment, if the API requires authentication and can be called only when it is bound to a usage plan, you can use this API to bind a usage plan to the specified environment. Currently, a usage plan can be bound to an API; however, under the same service, usage plans bound to a service and usage plans bound to an API cannot coexist. Therefore, in an environment to which a service-level usage plan has already been bound, please use the `DemoteServiceUsagePlan` API to degrade it.

Parameters:

req - BindEnvironmentRequest

Returns:

BindEnvironmentResponse

Throws:

TencentCloudSDKException

BindIPStrategy

public BindIPStrategyResponse BindIPStrategy(BindIPStrategyRequest req)
                                      throws TencentCloudSDKException

This API is used to bind an IP policy to an API.

Parameters:

req - BindIPStrategyRequest

Returns:

BindIPStrategyResponse

Throws:

TencentCloudSDKException

BindSecretIds

public BindSecretIdsResponse BindSecretIds(BindSecretIdsRequest req)
                                    throws TencentCloudSDKException

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.

Parameters:

req - BindSecretIdsRequest

Returns:

BindSecretIdsResponse

Throws:

TencentCloudSDKException

BindSubDomain

public BindSubDomainResponse BindSubDomain(BindSubDomainRequest req)
                                    throws TencentCloudSDKException

This API is used to bind a custom domain name to a service. Each service in API Gateway provides a default domain name for users to call. If you want to use your own domain name, you can bind a custom domain name to the target service. After getting the ICP filing and configuring the CNAME record between the custom and default domain names, you can directly call the custom domain name.

Parameters:

req - BindSubDomainRequest

Returns:

BindSubDomainResponse

Throws:

TencentCloudSDKException

BuildAPIDoc

public BuildAPIDocResponse BuildAPIDoc(BuildAPIDocRequest req)
                                throws TencentCloudSDKException

This API is used to build an API document.

Parameters:

req - BuildAPIDocRequest

Returns:

BuildAPIDocResponse

Throws:

TencentCloudSDKException

CreateAPIDoc

public CreateAPIDocResponse CreateAPIDoc(CreateAPIDocRequest req)
                                  throws TencentCloudSDKException

This API is used to create an API document.

Parameters:

req - CreateAPIDocRequest

Returns:

CreateAPIDocResponse

Throws:

TencentCloudSDKException

CreateApi

public CreateApiResponse CreateApi(CreateApiRequest req)
                            throws TencentCloudSDKException

This API is used to create an API. Before creating an API, you need to create a service, as each API belongs to a certain service.

Parameters:

req - CreateApiRequest

Returns:

CreateApiResponse

Throws:

TencentCloudSDKException

CreateApiApp

public CreateApiAppResponse CreateApiApp(CreateApiAppRequest req)
                                  throws TencentCloudSDKException

This API is used to create an application.

Parameters:

req - CreateApiAppRequest

Returns:

CreateApiAppResponse

Throws:

TencentCloudSDKException

CreateApiKey

public CreateApiKeyResponse CreateApiKey(CreateApiKeyRequest req)
                                  throws TencentCloudSDKException

This API is used to create an API key pair.

Parameters:

req - CreateApiKeyRequest

Returns:

CreateApiKeyResponse

Throws:

TencentCloudSDKException

CreateIPStrategy

public CreateIPStrategyResponse CreateIPStrategy(CreateIPStrategyRequest req)
                                          throws TencentCloudSDKException

This API is used to create a service IP policy.

Parameters:

req - CreateIPStrategyRequest

Returns:

CreateIPStrategyResponse

Throws:

TencentCloudSDKException

CreatePlugin

public CreatePluginResponse CreatePlugin(CreatePluginRequest req)
                                  throws TencentCloudSDKException

This API is used to create an API Gateway plugin.

Parameters:

req - CreatePluginRequest

Returns:

CreatePluginResponse

Throws:

TencentCloudSDKException

CreateService

public CreateServiceResponse CreateService(CreateServiceRequest req)
                                    throws TencentCloudSDKException

This API is used to create a service. A service is the biggest usage unit in API Gateway. Each service can contain multiple APIs and one default domain name for invocation. You can also bind your own custom domain name to a service.

Parameters:

req - CreateServiceRequest

Returns:

CreateServiceResponse

Throws:

TencentCloudSDKException

CreateUpstream

public CreateUpstreamResponse CreateUpstream(CreateUpstreamRequest req)
                                      throws TencentCloudSDKException

This API is used to create an upstream.

Parameters:

req - CreateUpstreamRequest

Returns:

CreateUpstreamResponse

Throws:

TencentCloudSDKException

CreateUsagePlan

public CreateUsagePlanResponse CreateUsagePlan(CreateUsagePlanRequest req)
                                        throws TencentCloudSDKException

This API is used to create a usage plan. To use API Gateway, you need to create a usage plan and bind it to a service environment.

Parameters:

req - CreateUsagePlanRequest

Returns:

CreateUsagePlanResponse

Throws:

TencentCloudSDKException

DeleteAPIDoc

public DeleteAPIDocResponse DeleteAPIDoc(DeleteAPIDocRequest req)
                                  throws TencentCloudSDKException

This API is used to delete an API document.

Parameters:

req - DeleteAPIDocRequest

Returns:

DeleteAPIDocResponse

Throws:

TencentCloudSDKException

DeleteApi

public DeleteApiResponse DeleteApi(DeleteApiRequest req)
                            throws TencentCloudSDKException

This API is used to delete a created API.

Parameters:

req - DeleteApiRequest

Returns:

DeleteApiResponse

Throws:

TencentCloudSDKException

DeleteApiApp

public DeleteApiAppResponse DeleteApiApp(DeleteApiAppRequest req)
                                  throws TencentCloudSDKException

This API is used to delete a created application.

Parameters:

req - DeleteApiAppRequest

Returns:

DeleteApiAppResponse

Throws:

TencentCloudSDKException

DeleteApiKey

public DeleteApiKeyResponse DeleteApiKey(DeleteApiKeyRequest req)
                                  throws TencentCloudSDKException

This API is used to delete an API key pair.

Parameters:

req - DeleteApiKeyRequest

Returns:

DeleteApiKeyResponse

Throws:

TencentCloudSDKException

DeleteIPStrategy

public DeleteIPStrategyResponse DeleteIPStrategy(DeleteIPStrategyRequest req)
                                          throws TencentCloudSDKException

This API is used to delete a service IP policy.

Parameters:

req - DeleteIPStrategyRequest

Returns:

DeleteIPStrategyResponse

Throws:

TencentCloudSDKException

DeletePlugin

public DeletePluginResponse DeletePlugin(DeletePluginRequest req)
                                  throws TencentCloudSDKException

This API is used to delete an API Gateway plugin.

Parameters:

req - DeletePluginRequest

Returns:

DeletePluginResponse

Throws:

TencentCloudSDKException

DeleteService

public DeleteServiceResponse DeleteService(DeleteServiceRequest req)
                                    throws TencentCloudSDKException

This API is used to delete a service in API Gateway.

Parameters:

req - DeleteServiceRequest

Returns:

DeleteServiceResponse

Throws:

TencentCloudSDKException

DeleteServiceSubDomainMapping

public DeleteServiceSubDomainMappingResponse DeleteServiceSubDomainMapping(DeleteServiceSubDomainMappingRequest req)
                                                                    throws TencentCloudSDKException

This API is used to delete a custom domain name mapping in a service environment. You can use this API if you use a custom domain name and custom mapping. Please note that if you delete all mappings in all environments, a failure will be returned when this API is called.

Parameters:

req - DeleteServiceSubDomainMappingRequest

Returns:

DeleteServiceSubDomainMappingResponse

Throws:

TencentCloudSDKException

DeleteUpstream

public DeleteUpstreamResponse DeleteUpstream(DeleteUpstreamRequest req)
                                      throws TencentCloudSDKException

This API is used to delete an upstream. Note that you can only delete an upstream when it’s not bound with any APIs.

Parameters:

req - DeleteUpstreamRequest

Returns:

DeleteUpstreamResponse

Throws:

TencentCloudSDKException

DeleteUsagePlan

public DeleteUsagePlanResponse DeleteUsagePlan(DeleteUsagePlanRequest req)
                                        throws TencentCloudSDKException

This API is used to delete a usage plan.

Parameters:

req - DeleteUsagePlanRequest

Returns:

DeleteUsagePlanResponse

Throws:

TencentCloudSDKException

DemoteServiceUsagePlan

public DemoteServiceUsagePlanResponse DemoteServiceUsagePlan(DemoteServiceUsagePlanRequest req)
                                                      throws TencentCloudSDKException

This API is used to degrade a usage plan of a service in an environment to the API level. This operation will be denied if there are no APIs under the service. This operation will also be denied if the current environment has not been published.

Parameters:

req - DemoteServiceUsagePlanRequest

Returns:

DemoteServiceUsagePlanResponse

Throws:

TencentCloudSDKException

DescribeAPIDocDetail

public DescribeAPIDocDetailResponse DescribeAPIDocDetail(DescribeAPIDocDetailRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the details of an API document.

Parameters:

req - DescribeAPIDocDetailRequest

Returns:

DescribeAPIDocDetailResponse

Throws:

TencentCloudSDKException

DescribeAPIDocs

public DescribeAPIDocsResponse DescribeAPIDocs(DescribeAPIDocsRequest req)
                                        throws TencentCloudSDKException

This API is used to query the list of API documents.

Parameters:

req - DescribeAPIDocsRequest

Returns:

DescribeAPIDocsResponse

Throws:

TencentCloudSDKException

DescribeAllPluginApis

public DescribeAllPluginApisResponse DescribeAllPluginApis(DescribeAllPluginApisRequest req)
                                                    throws TencentCloudSDKException

This API is used to list all APIs that can use this plugin, no matter whether the API is bound with the plugin.

Parameters:

req - DescribeAllPluginApisRequest

Returns:

DescribeAllPluginApisResponse

Throws:

TencentCloudSDKException

DescribeApi

public DescribeApiResponse DescribeApi(DescribeApiRequest req)
                                throws TencentCloudSDKException

This API (`DescribeApi`) is used to query the details of the APIs users manage via Tencent Cloud API Gateway.

Parameters:

req - DescribeApiRequest

Returns:

DescribeApiResponse

Throws:

TencentCloudSDKException

DescribeApiApp

public DescribeApiAppResponse DescribeApiApp(DescribeApiAppRequest req)
                                      throws TencentCloudSDKException

This API is used to search for an application by application ID.

Parameters:

req - DescribeApiAppRequest

Returns:

DescribeApiAppResponse

Throws:

TencentCloudSDKException

DescribeApiAppBindApisStatus

public DescribeApiAppBindApisStatusResponse DescribeApiAppBindApisStatus(DescribeApiAppBindApisStatusRequest req)
                                                                  throws TencentCloudSDKException

This API is used to query the list of APIs bound to an application.

Parameters:

req - DescribeApiAppBindApisStatusRequest

Returns:

DescribeApiAppBindApisStatusResponse

Throws:

TencentCloudSDKException

DescribeApiAppsStatus

public DescribeApiAppsStatusResponse DescribeApiAppsStatus(DescribeApiAppsStatusRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the application list.

Parameters:

req - DescribeApiAppsStatusRequest

Returns:

DescribeApiAppsStatusResponse

Throws:

TencentCloudSDKException

DescribeApiBindApiAppsStatus

public DescribeApiBindApiAppsStatusResponse DescribeApiBindApiAppsStatus(DescribeApiBindApiAppsStatusRequest req)
                                                                  throws TencentCloudSDKException

This API is used to query the list of applications bound to an API.

Parameters:

req - DescribeApiBindApiAppsStatusRequest

Returns:

DescribeApiBindApiAppsStatusResponse

Throws:

TencentCloudSDKException

DescribeApiEnvironmentStrategy

public DescribeApiEnvironmentStrategyResponse DescribeApiEnvironmentStrategy(DescribeApiEnvironmentStrategyRequest req)
                                                                      throws TencentCloudSDKException

This API is used to display the throttling policies bound to an API.

Parameters:

req - DescribeApiEnvironmentStrategyRequest

Returns:

DescribeApiEnvironmentStrategyResponse

Throws:

TencentCloudSDKException

DescribeApiForApiApp

public DescribeApiForApiAppResponse DescribeApiForApiApp(DescribeApiForApiAppRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the details of an API deployed at API Gateway.

Parameters:

req - DescribeApiForApiAppRequest

Returns:

DescribeApiForApiAppResponse

Throws:

TencentCloudSDKException

DescribeApiKey

public DescribeApiKeyResponse DescribeApiKey(DescribeApiKeyRequest req)
                                      throws TencentCloudSDKException

This API is used to query the details of a key. After creating an API key, you can query its details by using this API.

Parameters:

req - DescribeApiKeyRequest

Returns:

DescribeApiKeyResponse

Throws:

TencentCloudSDKException

DescribeApiKeysStatus

public DescribeApiKeysStatusResponse DescribeApiKeysStatus(DescribeApiKeysStatusRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the information of one or more API keys.

Parameters:

req - DescribeApiKeysStatusRequest

Returns:

DescribeApiKeysStatusResponse

Throws:

TencentCloudSDKException

DescribeApiUsagePlan

public DescribeApiUsagePlanResponse DescribeApiUsagePlan(DescribeApiUsagePlanRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the details of API usage plans in a service. To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service and APIs under it.

Parameters:

req - DescribeApiUsagePlanRequest

Returns:

DescribeApiUsagePlanResponse

Throws:

TencentCloudSDKException

DescribeApisStatus

public DescribeApisStatusResponse DescribeApisStatus(DescribeApisStatusRequest req)
                                              throws TencentCloudSDKException

This API is used to view a certain API or the list of all APIs under a service and relevant information.

Parameters:

req - DescribeApisStatusRequest

Returns:

DescribeApisStatusResponse

Throws:

TencentCloudSDKException

DescribeIPStrategy

public DescribeIPStrategyResponse DescribeIPStrategy(DescribeIPStrategyRequest req)
                                              throws TencentCloudSDKException

This API is used to query IP policy details.

Parameters:

req - DescribeIPStrategyRequest

Returns:

DescribeIPStrategyResponse

Throws:

TencentCloudSDKException

DescribeIPStrategyApisStatus

public DescribeIPStrategyApisStatusResponse DescribeIPStrategyApisStatus(DescribeIPStrategyApisStatusRequest req)
                                                                  throws TencentCloudSDKException

This API is used to query the list of APIs to which an IP policy can be bound, i.e., the difference set between all APIs under the service and the APIs already bound to the policy.

Parameters:

req - DescribeIPStrategyApisStatusRequest

Returns:

DescribeIPStrategyApisStatusResponse

Throws:

TencentCloudSDKException

DescribeIPStrategysStatus

public DescribeIPStrategysStatusResponse DescribeIPStrategysStatus(DescribeIPStrategysStatusRequest req)
                                                            throws TencentCloudSDKException

This API is used to query the list of service IP policies.

Parameters:

req - DescribeIPStrategysStatusRequest

Returns:

DescribeIPStrategysStatusResponse

Throws:

TencentCloudSDKException

DescribeLogSearch

public DescribeLogSearchResponse DescribeLogSearch(DescribeLogSearchRequest req)
                                            throws TencentCloudSDKException

This API is used to search for logs.

Parameters:

req - DescribeLogSearchRequest

Returns:

DescribeLogSearchResponse

Throws:

TencentCloudSDKException

DescribePlugin

public DescribePluginResponse DescribePlugin(DescribePluginRequest req)
                                      throws TencentCloudSDKException

This API is used to query the plugin details by plugin ID.

Parameters:

req - DescribePluginRequest

Returns:

DescribePluginResponse

Throws:

TencentCloudSDKException

DescribePluginApis

public DescribePluginApisResponse DescribePluginApis(DescribePluginApisRequest req)
                                              throws TencentCloudSDKException

This API is used to query APIs bound with a specified plugin.

Parameters:

req - DescribePluginApisRequest

Returns:

DescribePluginApisResponse

Throws:

TencentCloudSDKException

DescribePluginsByApi

public DescribePluginsByApiResponse DescribePluginsByApi(DescribePluginsByApiRequest req)
                                                  throws TencentCloudSDKException

This API is used to query all plug-ins bound with the API.

Parameters:

req - DescribePluginsByApiRequest

Returns:

DescribePluginsByApiResponse

Throws:

TencentCloudSDKException

DescribeService

public DescribeServiceResponse DescribeService(DescribeServiceRequest req)
                                        throws TencentCloudSDKException

This API is used to query the details of a service, such as its description, domain name, protocol, creation time, and releases.

Parameters:

req - DescribeServiceRequest

Returns:

DescribeServiceResponse

Throws:

TencentCloudSDKException

DescribeServiceEnvironmentList

public DescribeServiceEnvironmentListResponse DescribeServiceEnvironmentList(DescribeServiceEnvironmentListRequest req)
                                                                      throws TencentCloudSDKException

This API is used to query the list of environments under a service. All environments and their statuses under the queried service will be returned.

Parameters:

req - DescribeServiceEnvironmentListRequest

Returns:

DescribeServiceEnvironmentListResponse

Throws:

TencentCloudSDKException

DescribeServiceEnvironmentReleaseHistory

public DescribeServiceEnvironmentReleaseHistoryResponse DescribeServiceEnvironmentReleaseHistory(DescribeServiceEnvironmentReleaseHistoryRequest req)
                                                                                          throws TencentCloudSDKException

This API is used to query the release history in a service environment. A service can only be used when it is published to an environment after creation. This API is used to query the release history in an environment under a service.

Parameters:

req - DescribeServiceEnvironmentReleaseHistoryRequest

Returns:

DescribeServiceEnvironmentReleaseHistoryResponse

Throws:

TencentCloudSDKException

DescribeServiceEnvironmentStrategy

public DescribeServiceEnvironmentStrategyResponse DescribeServiceEnvironmentStrategy(DescribeServiceEnvironmentStrategyRequest req)
                                                                              throws TencentCloudSDKException

This API is used to display a service throttling policy.

Parameters:

req - DescribeServiceEnvironmentStrategyRequest

Returns:

DescribeServiceEnvironmentStrategyResponse

Throws:

TencentCloudSDKException

DescribeServiceForApiApp

public DescribeServiceForApiAppResponse DescribeServiceForApiApp(DescribeServiceForApiAppRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the details of a service, such as its description, domain name, and protocol.

Parameters:

req - DescribeServiceForApiAppRequest

Returns:

DescribeServiceForApiAppResponse

Throws:

TencentCloudSDKException

DescribeServiceReleaseVersion

public DescribeServiceReleaseVersionResponse DescribeServiceReleaseVersion(DescribeServiceReleaseVersionRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query the list of all published versions under a service. A service is generally published on several versions. This API can be used to query the published versions.

Parameters:

req - DescribeServiceReleaseVersionRequest

Returns:

DescribeServiceReleaseVersionResponse

Throws:

TencentCloudSDKException

DescribeServiceSubDomainMappings

public DescribeServiceSubDomainMappingsResponse DescribeServiceSubDomainMappings(DescribeServiceSubDomainMappingsRequest req)
                                                                          throws TencentCloudSDKException

This API is used to query the path mappings of a custom domain name. In API Gateway, you can bind a custom domain name to a service and map its paths. You can customize different path mappings to up to 3 environments under the service. This API is used to query the list of path mappings of a custom domain name bound to a service.

Parameters:

req - DescribeServiceSubDomainMappingsRequest

Returns:

DescribeServiceSubDomainMappingsResponse

Throws:

TencentCloudSDKException

DescribeServiceSubDomains

public DescribeServiceSubDomainsResponse DescribeServiceSubDomains(DescribeServiceSubDomainsRequest req)
                                                            throws TencentCloudSDKException

This API is used to query the list of custom domain names. In API Gateway, you can bind custom domain names to a service for service call. This API is used to query the list of custom domain names bound to a service.

Parameters:

req - DescribeServiceSubDomainsRequest

Returns:

DescribeServiceSubDomainsResponse

Throws:

TencentCloudSDKException

DescribeServiceUsagePlan

public DescribeServiceUsagePlanResponse DescribeServiceUsagePlan(DescribeServiceUsagePlanRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the details of usage plans in a service. To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service.

Parameters:

req - DescribeServiceUsagePlanRequest

Returns:

DescribeServiceUsagePlanResponse

Throws:

TencentCloudSDKException

DescribeServicesStatus

public DescribeServicesStatusResponse DescribeServicesStatus(DescribeServicesStatusRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the list of one or more services and return relevant domain name, time, and other information.

Parameters:

req - DescribeServicesStatusRequest

Returns:

DescribeServicesStatusResponse

Throws:

TencentCloudSDKException

DescribeUpstreamBindApis

public DescribeUpstreamBindApisResponse DescribeUpstreamBindApis(DescribeUpstreamBindApisRequest req)
                                                          throws TencentCloudSDKException

This API is used to query APIs bound with an upstream.

Parameters:

req - DescribeUpstreamBindApisRequest

Returns:

DescribeUpstreamBindApisResponse

Throws:

TencentCloudSDKException

DescribeUpstreams

public DescribeUpstreamsResponse DescribeUpstreams(DescribeUpstreamsRequest req)
                                            throws TencentCloudSDKException

This API is used to query details of upstreams under the current account.

Parameters:

req - DescribeUpstreamsRequest

Returns:

DescribeUpstreamsResponse

Throws:

TencentCloudSDKException

DescribeUsagePlan

public DescribeUsagePlanResponse DescribeUsagePlan(DescribeUsagePlanRequest req)
                                            throws TencentCloudSDKException

This API is used to query the details of a usage plan, such as its name, QPS, creation time, and bound environment.

Parameters:

req - DescribeUsagePlanRequest

Returns:

DescribeUsagePlanResponse

Throws:

TencentCloudSDKException

DescribeUsagePlanEnvironments

public DescribeUsagePlanEnvironmentsResponse DescribeUsagePlanEnvironments(DescribeUsagePlanEnvironmentsRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query the list of environments bound to a usage plan. After binding a usage plan to environments, you can use this API to query all service environments bound to the usage plan.

Parameters:

req - DescribeUsagePlanEnvironmentsRequest

Returns:

DescribeUsagePlanEnvironmentsResponse

Throws:

TencentCloudSDKException

DescribeUsagePlanSecretIds

public DescribeUsagePlanSecretIdsResponse DescribeUsagePlanSecretIds(DescribeUsagePlanSecretIdsRequest req)
                                                              throws TencentCloudSDKException

This API is used to query the list of keys bound to a usage plan. In API Gateway, a usage plan can be bound to multiple key pairs. You can use this API to query the list of keys bound to it.

Parameters:

req - DescribeUsagePlanSecretIdsRequest

Returns:

DescribeUsagePlanSecretIdsResponse

Throws:

TencentCloudSDKException

DescribeUsagePlansStatus

public DescribeUsagePlansStatusResponse DescribeUsagePlansStatus(DescribeUsagePlansStatusRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the list of usage plans.

Parameters:

req - DescribeUsagePlansStatusRequest

Returns:

DescribeUsagePlansStatusResponse

Throws:

TencentCloudSDKException

DetachPlugin

public DetachPluginResponse DetachPlugin(DetachPluginRequest req)
                                  throws TencentCloudSDKException

This API is used to unbind an API from the plugin.

Parameters:

req - DetachPluginRequest

Returns:

DetachPluginResponse

Throws:

TencentCloudSDKException

DisableApiKey

public DisableApiKeyResponse DisableApiKey(DisableApiKeyRequest req)
                                    throws TencentCloudSDKException

This API is used to disable an API key.

Parameters:

req - DisableApiKeyRequest

Returns:

DisableApiKeyResponse

Throws:

TencentCloudSDKException

EnableApiKey

public EnableApiKeyResponse EnableApiKey(EnableApiKeyRequest req)
                                  throws TencentCloudSDKException

This API is used to enable a disabled API key.

Parameters:

req - EnableApiKeyRequest

Returns:

EnableApiKeyResponse

Throws:

TencentCloudSDKException

GenerateApiDocument

public GenerateApiDocumentResponse GenerateApiDocument(GenerateApiDocumentRequest req)
                                                throws TencentCloudSDKException

This API is used to automatically generate API documents and SDKs. One document and one SDK will be generated for each environment under each service, respectively.

Parameters:

req - GenerateApiDocumentRequest

Returns:

GenerateApiDocumentResponse

Throws:

TencentCloudSDKException

ImportOpenApi

public ImportOpenApiResponse ImportOpenApi(ImportOpenApiRequest req)
                                    throws TencentCloudSDKException

This API is used to import an OpenAPI to API gateway.

Parameters:

req - ImportOpenApiRequest

Returns:

ImportOpenApiResponse

Throws:

TencentCloudSDKException

ModifyAPIDoc

public ModifyAPIDocResponse ModifyAPIDoc(ModifyAPIDocRequest req)
                                  throws TencentCloudSDKException

This API is used to modify an API document.

Parameters:

req - ModifyAPIDocRequest

Returns:

ModifyAPIDocResponse

Throws:

TencentCloudSDKException

ModifyApi

public ModifyApiResponse ModifyApi(ModifyApiRequest req)
                            throws TencentCloudSDKException

This API is used to modify an API. You can call this API to edit/modify a configured API. The modified API takes effect only after its service is published to the corresponding environment again.

Parameters:

req - ModifyApiRequest

Returns:

ModifyApiResponse

Throws:

TencentCloudSDKException

ModifyApiApp

public ModifyApiAppResponse ModifyApiApp(ModifyApiAppRequest req)
                                  throws TencentCloudSDKException

This API is used to modify a created API.

Parameters:

req - ModifyApiAppRequest

Returns:

ModifyApiAppResponse

Throws:

TencentCloudSDKException

ModifyApiEnvironmentStrategy

public ModifyApiEnvironmentStrategyResponse ModifyApiEnvironmentStrategy(ModifyApiEnvironmentStrategyRequest req)
                                                                  throws TencentCloudSDKException

This API is used to modify an API throttling policy.

Parameters:

req - ModifyApiEnvironmentStrategyRequest

Returns:

ModifyApiEnvironmentStrategyResponse

Throws:

TencentCloudSDKException

ModifyApiIncrement

public ModifyApiIncrementResponse ModifyApiIncrement(ModifyApiIncrementRequest req)
                                              throws TencentCloudSDKException

This API is used to incrementally update an API and mainly called by programs (different from `ModifyApi`, which requires that full API parameters be passed in and is suitable for use in the console).

Parameters:

req - ModifyApiIncrementRequest

Returns:

ModifyApiIncrementResponse

Throws:

TencentCloudSDKException

ModifyIPStrategy

public ModifyIPStrategyResponse ModifyIPStrategy(ModifyIPStrategyRequest req)
                                          throws TencentCloudSDKException

This API is used to modify a service IP policy.

Parameters:

req - ModifyIPStrategyRequest

Returns:

ModifyIPStrategyResponse

Throws:

TencentCloudSDKException

ModifyPlugin

public ModifyPluginResponse ModifyPlugin(ModifyPluginRequest req)
                                  throws TencentCloudSDKException

This API is used to modify a plugin.

Parameters:

req - ModifyPluginRequest

Returns:

ModifyPluginResponse

Throws:

TencentCloudSDKException

ModifyService

public ModifyServiceResponse ModifyService(ModifyServiceRequest req)
                                    throws TencentCloudSDKException

This API is used to modify the relevant information of a service. After a service is created, its name, description, and service type can be modified.

Parameters:

req - ModifyServiceRequest

Returns:

ModifyServiceResponse

Throws:

TencentCloudSDKException

ModifyServiceEnvironmentStrategy

public ModifyServiceEnvironmentStrategyResponse ModifyServiceEnvironmentStrategy(ModifyServiceEnvironmentStrategyRequest req)
                                                                          throws TencentCloudSDKException

This API is used to modify a service throttling policy.

Parameters:

req - ModifyServiceEnvironmentStrategyRequest

Returns:

ModifyServiceEnvironmentStrategyResponse

Throws:

TencentCloudSDKException

ModifySubDomain

public ModifySubDomainResponse ModifySubDomain(ModifySubDomainRequest req)
                                        throws TencentCloudSDKException

This API is used to modify the path mapping in the custom domain name settings of a service. The path mapping rule can be modified before it is bound to the custom domain name.

Parameters:

req - ModifySubDomainRequest

Returns:

ModifySubDomainResponse

Throws:

TencentCloudSDKException

ModifyUpstream

public ModifyUpstreamResponse ModifyUpstream(ModifyUpstreamRequest req)
                                      throws TencentCloudSDKException

This API is used to modify an upstream.

Parameters:

req - ModifyUpstreamRequest

Returns:

ModifyUpstreamResponse

Throws:

TencentCloudSDKException

ModifyUsagePlan

public ModifyUsagePlanResponse ModifyUsagePlan(ModifyUsagePlanRequest req)
                                        throws TencentCloudSDKException

This API is used to modify the name, description, and QPS of a usage plan.

Parameters:

req - ModifyUsagePlanRequest

Returns:

ModifyUsagePlanResponse

Throws:

TencentCloudSDKException

ReleaseService

public ReleaseServiceResponse ReleaseService(ReleaseServiceRequest req)
                                      throws TencentCloudSDKException

This API is used to publish a service. An API Gateway service can only be called when it is published to an environment and takes effect after creation. This API is used to publish a service to an environment such as the `release` environment.

Parameters:

req - ReleaseServiceRequest

Returns:

ReleaseServiceResponse

Throws:

TencentCloudSDKException

ResetAPIDocPassword

public ResetAPIDocPasswordResponse ResetAPIDocPassword(ResetAPIDocPasswordRequest req)
                                                throws TencentCloudSDKException

This API is used to reset the password of an API document.

Parameters:

req - ResetAPIDocPasswordRequest

Returns:

ResetAPIDocPasswordResponse

Throws:

TencentCloudSDKException

UnBindEnvironment

public UnBindEnvironmentResponse UnBindEnvironment(UnBindEnvironmentRequest req)
                                            throws TencentCloudSDKException

This API is used to unbind a usage plan from a specified environment.

Parameters:

req - UnBindEnvironmentRequest

Returns:

UnBindEnvironmentResponse

Throws:

TencentCloudSDKException

UnBindIPStrategy

public UnBindIPStrategyResponse UnBindIPStrategy(UnBindIPStrategyRequest req)
                                          throws TencentCloudSDKException

This API is used to unbind an IP policy from a service.

Parameters:

req - UnBindIPStrategyRequest

Returns:

UnBindIPStrategyResponse

Throws:

TencentCloudSDKException

UnBindSecretIds

public UnBindSecretIdsResponse UnBindSecretIds(UnBindSecretIdsRequest req)
                                        throws TencentCloudSDKException

This API is used to unbind a key from a usage plan.

Parameters:

req - UnBindSecretIdsRequest

Returns:

UnBindSecretIdsResponse

Throws:

TencentCloudSDKException

UnBindSubDomain

public UnBindSubDomainResponse UnBindSubDomain(UnBindSubDomainRequest req)
                                        throws TencentCloudSDKException

This API is used to unbind a custom domain name. After binding a custom domain name to a service by using API Gateway, you can use this API to unbind it.

Parameters:

req - UnBindSubDomainRequest

Returns:

UnBindSubDomainResponse

Throws:

TencentCloudSDKException

UnReleaseService

public UnReleaseServiceResponse UnReleaseService(UnReleaseServiceRequest req)
                                          throws TencentCloudSDKException

This API is used to deactivate a service. Only after a service is published to an environment can its APIs be called. You can call this API to deactivate a service in the release environment. Once deactivated, the service cannot be called.

Parameters:

req - UnReleaseServiceRequest

Returns:

UnReleaseServiceResponse

Throws:

TencentCloudSDKException

UnbindApiApp

public UnbindApiAppResponse UnbindApiApp(UnbindApiAppRequest req)
                                  throws TencentCloudSDKException

This API is used to unbind an application from an API.

Parameters:

req - UnbindApiAppRequest

Returns:

UnbindApiAppResponse

Throws:

TencentCloudSDKException

UpdateApiAppKey

public UpdateApiAppKeyResponse UpdateApiAppKey(UpdateApiAppKeyRequest req)
                                        throws TencentCloudSDKException

This API is used to update an application key.

Parameters:

req - UpdateApiAppKeyRequest

Returns:

UpdateApiAppKeyResponse

Throws:

TencentCloudSDKException

UpdateApiKey

public UpdateApiKeyResponse UpdateApiKey(UpdateApiKeyRequest req)
                                  throws TencentCloudSDKException

This API is used to update a created API key pair.

Parameters:

req - UpdateApiKeyRequest

Returns:

UpdateApiKeyResponse

Throws:

TencentCloudSDKException

UpdateService

public UpdateServiceResponse UpdateService(UpdateServiceRequest req)
                                    throws TencentCloudSDKException

This API is used to switch the running version of a service published in an environment to a specified version. After you create a service by using API Gateway and publish it to an environment, multiple versions will be generated during development. In this case, you can call this API to switch versions.

Parameters:

req - UpdateServiceRequest

Returns:

UpdateServiceResponse

Throws:

TencentCloudSDKException