ApigatewayClient (tencentcloud-sdk-java 3.1.1353 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachPluginResponse`	`AttachPlugin(AttachPluginRequest req)` 绑定插件到API上。
`BindApiAppResponse`	`BindApiApp(BindApiAppRequest req)` 本接口（BindApiApp）用于绑定应用到API。
`BindEnvironmentResponse`	`BindEnvironment(BindEnvironmentRequest req)` 本接口（BindEnvironment）用于绑定使用计划到服务或API。用户在发布服务到某个环境中后，如果 API 需要鉴权，还需要绑定使用计划才能进行调用，此接口用户将使用计划绑定到特定环境。目前支持绑定使用计划到API，但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划，所以对已经绑定过服务级别使用计划的环境，请先使用服务级别使用计划降级接口进行降级操作。
`BindIPStrategyResponse`	`BindIPStrategy(BindIPStrategyRequest req)` 本接口（BindIPStrategy）用于API绑定IP策略。
`BindSecretIdsResponse`	`BindSecretIds(BindSecretIdsRequest req)` 本接口（BindSecretIds）用于为使用计划绑定密钥。将密钥绑定到某个使用计划，并将此使用计划绑定到某个服务发布的环境上，调用者方可使用此密钥调用这个服务中的 API，可使用本接口为使用计划绑定密钥。
`BindSubDomainResponse`	`BindSubDomain(BindSubDomainRequest req)` 本接口（BindSubDomain）用于绑定自定义域名到服务。 API 网关中每个服务都会提供一个默认的域名供用户调用，但当用户想使用自己的已有域名时，也可以将自定义域名绑定到此服务，在做好备案、与默认域名的 CNAME 后，可直接调用自定义域名。
`BuildAPIDocResponse`	`BuildAPIDoc(BuildAPIDocRequest req)` 构建 API 文档
`CreateApiResponse`	`CreateApi(CreateApiRequest req)` 本接口（CreateApi）用于创建 API 接口，创建 API 前，用户需要先创建服务，每个 API 都有自己归属的服务。
`CreateApiAppResponse`	`CreateApiApp(CreateApiAppRequest req)` 本接口（CreateApiApp）用于创建应用。
`CreateAPIDocResponse`	`CreateAPIDoc(CreateAPIDocRequest req)` 创建 API 文档
`CreateApiKeyResponse`	`CreateApiKey(CreateApiKeyRequest req)` 本接口（CreateApiKey）用于创建一对新的 API 密钥。
`CreateExclusiveInstancesResponse`	`CreateExclusiveInstances(CreateExclusiveInstancesRequest req)` 创建专享实例
`CreateIPStrategyResponse`	`CreateIPStrategy(CreateIPStrategyRequest req)` 本接口（CreateIPStrategy）用于创建服务IP策略。
`CreatePluginResponse`	`CreatePlugin(CreatePluginRequest req)` 创建API网关插件。
`CreateServiceResponse`	`CreateService(CreateServiceRequest req)` 本接口（CreateService）用于创建服务。 API 网关使用的最大单元为服务，每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用，用户也可绑定自定义域名到此服务中。
`CreateUpstreamResponse`	`CreateUpstream(CreateUpstreamRequest req)` 用于创建后端通道
`CreateUsagePlanResponse`	`CreateUsagePlan(CreateUsagePlanRequest req)` 本接口（CreateUsagePlan）用于创建使用计划。用户在使用 API 网关时，需要创建使用计划并将其绑定到服务的环境中使用。
`DeleteApiResponse`	`DeleteApi(DeleteApiRequest req)` 本接口（DeleteApi）用于删除已经创建的API。
`DeleteApiAppResponse`	`DeleteApiApp(DeleteApiAppRequest req)` 本接口（DeleteApiApp）用于删除已经创建的应用。
`DeleteAPIDocResponse`	`DeleteAPIDoc(DeleteAPIDocRequest req)` 删除 API 文档
`DeleteApiKeyResponse`	`DeleteApiKey(DeleteApiKeyRequest req)` 本接口（DeleteApiKey）用于删除一对 API 密钥。
`DeleteIPStrategyResponse`	`DeleteIPStrategy(DeleteIPStrategyRequest req)` 本接口（DeleteIPStrategy）用于删除服务IP策略。
`DeletePluginResponse`	`DeletePlugin(DeletePluginRequest req)` 删除API网关插件
`DeleteServiceResponse`	`DeleteService(DeleteServiceRequest req)` 本接口（DeleteService）用于删除 API 网关中某个服务。
`DeleteServiceSubDomainMappingResponse`	`DeleteServiceSubDomainMapping(DeleteServiceSubDomainMappingRequest req)` 本接口（DeleteServiceSubDomainMapping）用于删除服务中某个环境的自定义域名映射。当用户使用自定义域名，并使用了自定义映射时，可使用此接口。但需注意，若删除了所有环境的映射时，调用此 API 均会返回失败。
`DeleteUpstreamResponse`	`DeleteUpstream(DeleteUpstreamRequest req)` 删除后端通道，需要注意有API绑定时，不允许删除
`DeleteUsagePlanResponse`	`DeleteUsagePlan(DeleteUsagePlanRequest req)` 本接口（DeleteUsagePlan）用于删除使用计划。
`DemoteServiceUsagePlanResponse`	`DemoteServiceUsagePlan(DemoteServiceUsagePlanRequest req)` 本接口（DemoteServiceUsagePlan）用于将某个服务在某个环境的使用计划，降级到API上。如果服务内没有API不允许进行此操作。如果当前环境没有发布，不允许进行此操作。
`DescribeAllPluginApisResponse`	`DescribeAllPluginApis(DescribeAllPluginApisRequest req)` 展示插件相关的API列表，包括已绑定的和未绑定的API信息。
`DescribeApiResponse`	`DescribeApi(DescribeApiRequest req)` 本接口（DescribeApi）用于查询用户 API 网关的 API 接口的详细信息。
`DescribeApiAppResponse`	`DescribeApiApp(DescribeApiAppRequest req)` 本接口（DescribeApiApp）用于根据应用ID搜索应用。此接口已下线，如需使用功能请使用DescribeApiAppsStatus接口。
`DescribeApiAppBindApisStatusResponse`	`DescribeApiAppBindApisStatus(DescribeApiAppBindApisStatusRequest req)` 本接口（DescribeApiAppBindApisStatus）查询应用绑定的Api列表。
`DescribeApiAppsStatusResponse`	`DescribeApiAppsStatus(DescribeApiAppsStatusRequest req)` 本接口（DescribeApiAppsStatus）查询应用列表。
`DescribeApiBindApiAppsStatusResponse`	`DescribeApiBindApiAppsStatus(DescribeApiBindApiAppsStatusRequest req)` 本接口（DescribeApiBindApiAppsStatus）查询Api绑定的应用列表。
`DescribeAPIDocDetailResponse`	`DescribeAPIDocDetail(DescribeAPIDocDetailRequest req)` 查询 API 文档详情
`DescribeAPIDocsResponse`	`DescribeAPIDocs(DescribeAPIDocsRequest req)` 查询 API 文档列表
`DescribeApiEnvironmentStrategyResponse`	`DescribeApiEnvironmentStrategy(DescribeApiEnvironmentStrategyRequest req)` 本接口（DescribeApiEnvironmentStrategy）用于展示API绑定的限流策略。
`DescribeApiForApiAppResponse`	`DescribeApiForApiApp(DescribeApiForApiAppRequest req)` 本接口（DescribeApiForApiApp）用于应用使用者查询部署于 API 网关的 API 接口的详细信息。
`DescribeApiKeyResponse`	`DescribeApiKey(DescribeApiKeyRequest req)` 本接口（DescribeApiKey）用于查询密钥详情。用户在创建密钥后，可用此接口查询一个 API 密钥的详情，该接口会显示密钥 Key。
`DescribeApiKeysStatusResponse`	`DescribeApiKeysStatus(DescribeApiKeysStatusRequest req)` 本接口（DescribeApiKeysStatus）用于查询密钥列表。当用户创建了多个密钥对时，可使用本接口查询一个或多个 API 密钥信息。
`DescribeApisStatusResponse`	`DescribeApisStatus(DescribeApisStatusRequest req)` 本接口（DescribeApisStatus）用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。
`DescribeApiUsagePlanResponse`	`DescribeApiUsagePlan(DescribeApiUsagePlanRequest req)` 本接口（DescribeApiUsagePlan）用于查询服务中 API 使用计划详情。服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务及其中 API 的所有使用计划。
`DescribeExclusiveInstanceDetailResponse`	`DescribeExclusiveInstanceDetail(DescribeExclusiveInstanceDetailRequest req)` 本接口（DescribeExclusiveInstanceDetail）用于查询独享实例详情信息。
`DescribeExclusiveInstanceRegionsResponse`	`DescribeExclusiveInstanceRegions(DescribeExclusiveInstanceRegionsRequest req)` Get the list of supported regions for dedicated instances
`DescribeExclusiveInstancesResponse`	`DescribeExclusiveInstances(DescribeExclusiveInstancesRequest req)` 本接口（DescribeExclusiveInstances）用于查询独享实例列表信息。
`DescribeExclusiveInstancesStatusResponse`	`DescribeExclusiveInstancesStatus(DescribeExclusiveInstancesStatusRequest req)` 查询专享实例列表（新）
`DescribeInstancesNetworkConfigResponse`	`DescribeInstancesNetworkConfig(DescribeInstancesNetworkConfigRequest req)` 获取专享实例网络配置列表
`DescribeIPStrategyResponse`	`DescribeIPStrategy(DescribeIPStrategyRequest req)` 本接口（DescribeIPStrategy）用于查询IP策略详情。
`DescribeIPStrategyApisStatusResponse`	`DescribeIPStrategyApisStatus(DescribeIPStrategyApisStatusRequest req)` 本接口（DescribeIPStrategyApisStatus）用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。
`DescribeIPStrategysStatusResponse`	`DescribeIPStrategysStatus(DescribeIPStrategysStatusRequest req)` 本接口（DescribeIPStrategysStatus）用于查询服务IP策略列表，因为接口名拼写错误，已不推荐使用，请优先使用DescribeIPStrategiesStatus接口。
`DescribeLogSearchResponse`	`DescribeLogSearch(DescribeLogSearchRequest req)` 本接口DescribeLogSearch用于搜索日志
`DescribePluginResponse`	`DescribePlugin(DescribePluginRequest req)` 展示插件详情，支持按照插件ID进行。
`DescribePluginApisResponse`	`DescribePluginApis(DescribePluginApisRequest req)` 查询指定插件下绑定的API信息
`DescribePluginsResponse`	`DescribePlugins(DescribePluginsRequest req)` 展示插件列表和详情，支持分页，支持按照插件类型查询，支持按照插件ID批量查询，支持按照插件名称查询。
`DescribePluginsByApiResponse`	`DescribePluginsByApi(DescribePluginsByApiRequest req)` 展示API上已绑定的插件列表。
`DescribeServiceResponse`	`DescribeService(DescribeServiceRequest req)` 本接口（DescribeService）用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。
`DescribeServiceEnvironmentListResponse`	`DescribeServiceEnvironmentList(DescribeServiceEnvironmentListRequest req)` 本接口（DescribeServiceEnvironmentList）用于查询一个服务的环境列表，可查询到此服务下所有环境及其状态。
`DescribeServiceEnvironmentReleaseHistoryResponse`	`DescribeServiceEnvironmentReleaseHistory(DescribeServiceEnvironmentReleaseHistoryRequest req)` 本接口（DescribeServiceEnvironmentReleaseHistory）用于查询服务环境的发布历史。用户在创建好服务后需要发布到某个环境中才能进行使用，本接口用于查询一个服务某个环境的发布记录。
`DescribeServiceEnvironmentStrategyResponse`	`DescribeServiceEnvironmentStrategy(DescribeServiceEnvironmentStrategyRequest req)` 本接口（DescribeServiceEnvironmentStrategy）用于展示服务限流策略。
`DescribeServiceForApiAppResponse`	`DescribeServiceForApiApp(DescribeServiceForApiAppRequest req)` 本接口（DescribeServiceForApiApp）用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。
`DescribeServiceReleaseVersionResponse`	`DescribeServiceReleaseVersion(DescribeServiceReleaseVersionRequest req)` 本接口（DescribeServiceReleaseVersion）查询一个服务下面所有已经发布的版本列表。用户在发布服务时，常有多个版本发布，可使用本接口查询已发布的版本。
`DescribeServicesStatusResponse`	`DescribeServicesStatus(DescribeServicesStatusRequest req)` 本接口（DescribeServicesStatus）用于搜索查询某一个服务或多个服务的列表，并返回服务相关的域名、时间等信息。
`DescribeServiceSubDomainMappingsResponse`	`DescribeServiceSubDomainMappings(DescribeServiceSubDomainMappingsRequest req)` 本接口（DescribeServiceSubDomainMappings）用于查询自定义域名的路径映射。 API 网关可绑定自定义域名到服务，并且可以对自定义域名的路径进行映射，可自定义不同的路径映射到服务中的三个环境，本接口用于查询绑定服务的自定义域名的路径映射列表。
`DescribeServiceSubDomainsResponse`	`DescribeServiceSubDomains(DescribeServiceSubDomainsRequest req)` 本接口（DescribeServiceSubDomains）用于查询自定义域名列表。 API 网关可绑定自定义域名到服务，用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。
`DescribeServiceUsagePlanResponse`	`DescribeServiceUsagePlan(DescribeServiceUsagePlanRequest req)` 本接口（DescribeServiceUsagePlan）用于查询服务使用计划详情。服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务的所有使用计划。
`DescribeUpstreamBindApisResponse`	`DescribeUpstreamBindApis(DescribeUpstreamBindApisRequest req)` 查询后端通道所绑定的API列表
`DescribeUpstreamsResponse`	`DescribeUpstreams(DescribeUpstreamsRequest req)` 查询后端通道列表详情
`DescribeUsagePlanResponse`	`DescribeUsagePlan(DescribeUsagePlanRequest req)` 本接口（DescribeUsagePlan）用于查询一个使用计划的详细信息，包括名称、QPS、创建时间绑定的环境等。
`DescribeUsagePlanEnvironmentsResponse`	`DescribeUsagePlanEnvironments(DescribeUsagePlanEnvironmentsRequest req)` 本接口（DescribeUsagePlanEnvironments）用于查询使用计划绑定的环境列表。用户在绑定了某个使用计划到环境后，可使用本接口查询这个使用计划绑定的所有服务的环境。
`DescribeUsagePlanSecretIdsResponse`	`DescribeUsagePlanSecretIds(DescribeUsagePlanSecretIdsRequest req)` 本接口（DescribeUsagePlanSecretIds）用于查询使用计划绑定的密钥列表。在 API 网关中，一个使用计划可绑定多个密钥对，可使用本接口查询使用计划绑定的密钥列表。
`DescribeUsagePlansStatusResponse`	`DescribeUsagePlansStatus(DescribeUsagePlansStatusRequest req)` 本接口（DescribeUsagePlanStatus）用于查询使用计划的列表。
`DetachPluginResponse`	`DetachPlugin(DetachPluginRequest req)` 解除插件与API绑定
`DisableApiKeyResponse`	`DisableApiKey(DisableApiKeyRequest req)` 本接口（DisableApiKey）用于禁用一对 API 密钥。
`EnableApiKeyResponse`	`EnableApiKey(EnableApiKeyRequest req)` 本接口（EnableApiKey）用于启动一对被禁用的 API 密钥。
`ImportOpenApiResponse`	`ImportOpenApi(ImportOpenApiRequest req)` 本接口（ImportOpenApi）用于将OpenAPI规范定义的API导入到API网关。
`ModifyApiResponse`	`ModifyApi(ModifyApiRequest req)` 本接口（ModifyApi）用于修改 API 接口，可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。
`ModifyApiAppResponse`	`ModifyApiApp(ModifyApiAppRequest req)` 本接口（ModifyApiApp）用于修改已经创建的应用。
`ModifyAPIDocResponse`	`ModifyAPIDoc(ModifyAPIDocRequest req)` 修改 API 文档
`ModifyApiEnvironmentStrategyResponse`	`ModifyApiEnvironmentStrategy(ModifyApiEnvironmentStrategyRequest req)` 本接口（ModifyApiEnvironmentStrategy）用于修改API限流策略
`ModifyApiIncrementResponse`	`ModifyApiIncrement(ModifyApiIncrementRequest req)` 提供增量更新API能力，主要是给程序调用（区别于ModifyApi，该接口是需要传入API的全量参数，对console使用较友好）
`ModifyExclusiveInstanceResponse`	`ModifyExclusiveInstance(ModifyExclusiveInstanceRequest req)` 本接口（ModifyExclusiveInstance）用于修改独享实例信息。
`ModifyIPStrategyResponse`	`ModifyIPStrategy(ModifyIPStrategyRequest req)` 本接口（ModifyIPStrategy）用于修改服务IP策略。
`ModifyPluginResponse`	`ModifyPlugin(ModifyPluginRequest req)` 修改API网关插件。
`ModifyServiceResponse`	`ModifyService(ModifyServiceRequest req)` 本接口（ModifyService）用于修改服务的相关信息。当服务创建后，服务的名称、描述和服务类型均可被修改。
`ModifyServiceEnvironmentStrategyResponse`	`ModifyServiceEnvironmentStrategy(ModifyServiceEnvironmentStrategyRequest req)` 本接口（ModifyServiceEnvironmentStrategy）用于修改服务限流策略
`ModifySubDomainResponse`	`ModifySubDomain(ModifySubDomainRequest req)` 本接口（ModifySubDomain）用于修改服务的自定义域名设置中的路径映射，可以修改绑定自定义域名之前的路径映射规则。
`ModifyUpstreamResponse`	`ModifyUpstream(ModifyUpstreamRequest req)` 修改后端通道
`ModifyUsagePlanResponse`	`ModifyUsagePlan(ModifyUsagePlanRequest req)` 本接口（ModifyUsagePlan）用于修改使用计划的名称，描述及 QPS。
`ReleaseServiceResponse`	`ReleaseService(ReleaseServiceRequest req)` 本接口（ReleaseService）用于发布服务。 API 网关的服务创建后，需要发布到某个环境方生效后，使用者才能进行调用，此接口用于发布服务到环境，如 release 环境。
`ResetAPIDocPasswordResponse`	`ResetAPIDocPassword(ResetAPIDocPasswordRequest req)` 重置API文档密码
`UnbindApiAppResponse`	`UnbindApiApp(UnbindApiAppRequest req)` 本接口（UnbindApiApp）用于解除应用和API绑定。
`UnBindEnvironmentResponse`	`UnBindEnvironment(UnBindEnvironmentRequest req)` 本接口（UnBindEnvironment）用于将使用计划从特定环境解绑。
`UnBindIPStrategyResponse`	`UnBindIPStrategy(UnBindIPStrategyRequest req)` 本接口（UnBindIPStrategy）用于服务解绑IP策略。
`UnBindSecretIdsResponse`	`UnBindSecretIds(UnBindSecretIdsRequest req)` 本接口（UnBindSecretIds）用于为使用计划解绑密钥。
`UnBindSubDomainResponse`	`UnBindSubDomain(UnBindSubDomainRequest req)` 本接口（UnBindSubDomain）用于解绑自定义域名。用户使用 API 网关绑定了自定义域名到服务中后，若想要解绑此自定义域名，可使用此接口。
`UnReleaseServiceResponse`	`UnReleaseService(UnReleaseServiceRequest req)` 本接口（UnReleaseService）用于下线服务。用户发布服务到某个环境后，此服务中的 API 方可被调用者进行调用，当用户需要将此服务从发布环境中下线时，可调用此 API。下线后的服务不可被调用。
`UpdateApiAppKeyResponse`	`UpdateApiAppKey(UpdateApiAppKeyRequest req)` 本接口（UpdateApiAppKey）用于更新应用密钥。
`UpdateApiKeyResponse`	`UpdateApiKey(UpdateApiKeyRequest req)` 本接口（UpdateApiKey）用于更换用户已创建的一对 API 密钥。
`UpdateServiceResponse`	`UpdateService(UpdateServiceRequest req)` 本接口（UpdateService）用于从服务已发布的环境中将运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后，如在开发过程产生多个版本需要切换，此时可调用本接口。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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
```
    绑定插件到API上。
    
    Parameters:
    
    req - AttachPluginRequest
    
    Returns:
    
    AttachPluginResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindApiApp
```
public BindApiAppResponse BindApiApp(BindApiAppRequest req)
                              throws TencentCloudSDKException
```
    本接口（BindApiApp）用于绑定应用到API。
    
    Parameters:
    
    req - BindApiAppRequest
    
    Returns:
    
    BindApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindEnvironment
```
public BindEnvironmentResponse BindEnvironment(BindEnvironmentRequest req)
                                        throws TencentCloudSDKException
```
    本接口（BindEnvironment）用于绑定使用计划到服务或API。用户在发布服务到某个环境中后，如果 API 需要鉴权，还需要绑定使用计划才能进行调用，此接口用户将使用计划绑定到特定环境。目前支持绑定使用计划到API，但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划，所以对已经绑定过服务级别使用计划的环境，请先使用服务级别使用计划降级接口进行降级操作。
    
    Parameters:
    
    req - BindEnvironmentRequest
    
    Returns:
    
    BindEnvironmentResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindIPStrategy
```
public BindIPStrategyResponse BindIPStrategy(BindIPStrategyRequest req)
                                      throws TencentCloudSDKException
```
    本接口（BindIPStrategy）用于API绑定IP策略。
    
    Parameters:
    
    req - BindIPStrategyRequest
    
    Returns:
    
    BindIPStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindSecretIds
```
public BindSecretIdsResponse BindSecretIds(BindSecretIdsRequest req)
                                    throws TencentCloudSDKException
```
    本接口（BindSecretIds）用于为使用计划绑定密钥。将密钥绑定到某个使用计划，并将此使用计划绑定到某个服务发布的环境上，调用者方可使用此密钥调用这个服务中的 API，可使用本接口为使用计划绑定密钥。
    
    Parameters:
    
    req - BindSecretIdsRequest
    
    Returns:
    
    BindSecretIdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindSubDomain
```
public BindSubDomainResponse BindSubDomain(BindSubDomainRequest req)
                                    throws TencentCloudSDKException
```
    本接口（BindSubDomain）用于绑定自定义域名到服务。 API 网关中每个服务都会提供一个默认的域名供用户调用，但当用户想使用自己的已有域名时，也可以将自定义域名绑定到此服务，在做好备案、与默认域名的 CNAME 后，可直接调用自定义域名。
    
    Parameters:
    
    req - BindSubDomainRequest
    
    Returns:
    
    BindSubDomainResponse
    
    Throws:
    
    TencentCloudSDKException
  - BuildAPIDoc
```
public BuildAPIDocResponse BuildAPIDoc(BuildAPIDocRequest req)
                                throws TencentCloudSDKException
```
    构建 API 文档
    
    Parameters:
    
    req - BuildAPIDocRequest
    
    Returns:
    
    BuildAPIDocResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateAPIDoc
```
public CreateAPIDocResponse CreateAPIDoc(CreateAPIDocRequest req)
                                  throws TencentCloudSDKException
```
    创建 API 文档
    
    Parameters:
    
    req - CreateAPIDocRequest
    
    Returns:
    
    CreateAPIDocResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateApi
```
public CreateApiResponse CreateApi(CreateApiRequest req)
                            throws TencentCloudSDKException
```
    本接口（CreateApi）用于创建 API 接口，创建 API 前，用户需要先创建服务，每个 API 都有自己归属的服务。
    
    Parameters:
    
    req - CreateApiRequest
    
    Returns:
    
    CreateApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateApiApp
```
public CreateApiAppResponse CreateApiApp(CreateApiAppRequest req)
                                  throws TencentCloudSDKException
```
    本接口（CreateApiApp）用于创建应用。
    
    Parameters:
    
    req - CreateApiAppRequest
    
    Returns:
    
    CreateApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateApiKey
```
public CreateApiKeyResponse CreateApiKey(CreateApiKeyRequest req)
                                  throws TencentCloudSDKException
```
    本接口（CreateApiKey）用于创建一对新的 API 密钥。
    
    Parameters:
    
    req - CreateApiKeyRequest
    
    Returns:
    
    CreateApiKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateExclusiveInstances
```
public CreateExclusiveInstancesResponse CreateExclusiveInstances(CreateExclusiveInstancesRequest req)
                                                          throws TencentCloudSDKException
```
    创建专享实例
    
    Parameters:
    
    req - CreateExclusiveInstancesRequest
    
    Returns:
    
    CreateExclusiveInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIPStrategy
```
public CreateIPStrategyResponse CreateIPStrategy(CreateIPStrategyRequest req)
                                          throws TencentCloudSDKException
```
    本接口（CreateIPStrategy）用于创建服务IP策略。
    
    Parameters:
    
    req - CreateIPStrategyRequest
    
    Returns:
    
    CreateIPStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePlugin
```
public CreatePluginResponse CreatePlugin(CreatePluginRequest req)
                                  throws TencentCloudSDKException
```
    创建API网关插件。
    
    Parameters:
    
    req - CreatePluginRequest
    
    Returns:
    
    CreatePluginResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateService
```
public CreateServiceResponse CreateService(CreateServiceRequest req)
                                    throws TencentCloudSDKException
```
    本接口（CreateService）用于创建服务。 API 网关使用的最大单元为服务，每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用，用户也可绑定自定义域名到此服务中。
    
    Parameters:
    
    req - CreateServiceRequest
    
    Returns:
    
    CreateServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUpstream
```
public CreateUpstreamResponse CreateUpstream(CreateUpstreamRequest req)
                                      throws TencentCloudSDKException
```
    用于创建后端通道
    
    Parameters:
    
    req - CreateUpstreamRequest
    
    Returns:
    
    CreateUpstreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUsagePlan
```
public CreateUsagePlanResponse CreateUsagePlan(CreateUsagePlanRequest req)
                                        throws TencentCloudSDKException
```
    本接口（CreateUsagePlan）用于创建使用计划。用户在使用 API 网关时，需要创建使用计划并将其绑定到服务的环境中使用。
    
    Parameters:
    
    req - CreateUsagePlanRequest
    
    Returns:
    
    CreateUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteAPIDoc
```
public DeleteAPIDocResponse DeleteAPIDoc(DeleteAPIDocRequest req)
                                  throws TencentCloudSDKException
```
    删除 API 文档
    
    Parameters:
    
    req - DeleteAPIDocRequest
    
    Returns:
    
    DeleteAPIDocResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteApi
```
public DeleteApiResponse DeleteApi(DeleteApiRequest req)
                            throws TencentCloudSDKException
```
    本接口（DeleteApi）用于删除已经创建的API。
    
    Parameters:
    
    req - DeleteApiRequest
    
    Returns:
    
    DeleteApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteApiApp
```
public DeleteApiAppResponse DeleteApiApp(DeleteApiAppRequest req)
                                  throws TencentCloudSDKException
```
    本接口（DeleteApiApp）用于删除已经创建的应用。
    
    Parameters:
    
    req - DeleteApiAppRequest
    
    Returns:
    
    DeleteApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteApiKey
```
public DeleteApiKeyResponse DeleteApiKey(DeleteApiKeyRequest req)
                                  throws TencentCloudSDKException
```
    本接口（DeleteApiKey）用于删除一对 API 密钥。
    
    Parameters:
    
    req - DeleteApiKeyRequest
    
    Returns:
    
    DeleteApiKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteIPStrategy
```
public DeleteIPStrategyResponse DeleteIPStrategy(DeleteIPStrategyRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DeleteIPStrategy）用于删除服务IP策略。
    
    Parameters:
    
    req - DeleteIPStrategyRequest
    
    Returns:
    
    DeleteIPStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeletePlugin
```
public DeletePluginResponse DeletePlugin(DeletePluginRequest req)
                                  throws TencentCloudSDKException
```
    删除API网关插件
    
    Parameters:
    
    req - DeletePluginRequest
    
    Returns:
    
    DeletePluginResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteService
```
public DeleteServiceResponse DeleteService(DeleteServiceRequest req)
                                    throws TencentCloudSDKException
```
    本接口（DeleteService）用于删除 API 网关中某个服务。
    
    Parameters:
    
    req - DeleteServiceRequest
    
    Returns:
    
    DeleteServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteServiceSubDomainMapping
```
public DeleteServiceSubDomainMappingResponse DeleteServiceSubDomainMapping(DeleteServiceSubDomainMappingRequest req)
                                                                    throws TencentCloudSDKException
```
    本接口（DeleteServiceSubDomainMapping）用于删除服务中某个环境的自定义域名映射。当用户使用自定义域名，并使用了自定义映射时，可使用此接口。但需注意，若删除了所有环境的映射时，调用此 API 均会返回失败。
    
    Parameters:
    
    req - DeleteServiceSubDomainMappingRequest
    
    Returns:
    
    DeleteServiceSubDomainMappingResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteUpstream
```
public DeleteUpstreamResponse DeleteUpstream(DeleteUpstreamRequest req)
                                      throws TencentCloudSDKException
```
    删除后端通道，需要注意有API绑定时，不允许删除
    
    Parameters:
    
    req - DeleteUpstreamRequest
    
    Returns:
    
    DeleteUpstreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteUsagePlan
```
public DeleteUsagePlanResponse DeleteUsagePlan(DeleteUsagePlanRequest req)
                                        throws TencentCloudSDKException
```
    本接口（DeleteUsagePlan）用于删除使用计划。
    
    Parameters:
    
    req - DeleteUsagePlanRequest
    
    Returns:
    
    DeleteUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - DemoteServiceUsagePlan
```
public DemoteServiceUsagePlanResponse DemoteServiceUsagePlan(DemoteServiceUsagePlanRequest req)
                                                      throws TencentCloudSDKException
```
    本接口（DemoteServiceUsagePlan）用于将某个服务在某个环境的使用计划，降级到API上。如果服务内没有API不允许进行此操作。如果当前环境没有发布，不允许进行此操作。
    
    Parameters:
    
    req - DemoteServiceUsagePlanRequest
    
    Returns:
    
    DemoteServiceUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAPIDocDetail
```
public DescribeAPIDocDetailResponse DescribeAPIDocDetail(DescribeAPIDocDetailRequest req)
                                                  throws TencentCloudSDKException
```
    查询 API 文档详情
    
    Parameters:
    
    req - DescribeAPIDocDetailRequest
    
    Returns:
    
    DescribeAPIDocDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAPIDocs
```
public DescribeAPIDocsResponse DescribeAPIDocs(DescribeAPIDocsRequest req)
                                        throws TencentCloudSDKException
```
    查询 API 文档列表
    
    Parameters:
    
    req - DescribeAPIDocsRequest
    
    Returns:
    
    DescribeAPIDocsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAllPluginApis
```
public DescribeAllPluginApisResponse DescribeAllPluginApis(DescribeAllPluginApisRequest req)
                                                    throws TencentCloudSDKException
```
    展示插件相关的API列表，包括已绑定的和未绑定的API信息。
    
    Parameters:
    
    req - DescribeAllPluginApisRequest
    
    Returns:
    
    DescribeAllPluginApisResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApi
```
public DescribeApiResponse DescribeApi(DescribeApiRequest req)
                                throws TencentCloudSDKException
```
    本接口（DescribeApi）用于查询用户 API 网关的 API 接口的详细信息。
    
    Parameters:
    
    req - DescribeApiRequest
    
    Returns:
    
    DescribeApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiApp
```
public DescribeApiAppResponse DescribeApiApp(DescribeApiAppRequest req)
                                      throws TencentCloudSDKException
```
    本接口（DescribeApiApp）用于根据应用ID搜索应用。此接口已下线，如需使用功能请使用DescribeApiAppsStatus接口。
    
    Parameters:
    
    req - DescribeApiAppRequest
    
    Returns:
    
    DescribeApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiAppBindApisStatus
```
public DescribeApiAppBindApisStatusResponse DescribeApiAppBindApisStatus(DescribeApiAppBindApisStatusRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口（DescribeApiAppBindApisStatus）查询应用绑定的Api列表。
    
    Parameters:
    
    req - DescribeApiAppBindApisStatusRequest
    
    Returns:
    
    DescribeApiAppBindApisStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiAppsStatus
```
public DescribeApiAppsStatusResponse DescribeApiAppsStatus(DescribeApiAppsStatusRequest req)
                                                    throws TencentCloudSDKException
```
    本接口（DescribeApiAppsStatus）查询应用列表。
    
    Parameters:
    
    req - DescribeApiAppsStatusRequest
    
    Returns:
    
    DescribeApiAppsStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiBindApiAppsStatus
```
public DescribeApiBindApiAppsStatusResponse DescribeApiBindApiAppsStatus(DescribeApiBindApiAppsStatusRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口（DescribeApiBindApiAppsStatus）查询Api绑定的应用列表。
    
    Parameters:
    
    req - DescribeApiBindApiAppsStatusRequest
    
    Returns:
    
    DescribeApiBindApiAppsStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiEnvironmentStrategy
```
public DescribeApiEnvironmentStrategyResponse DescribeApiEnvironmentStrategy(DescribeApiEnvironmentStrategyRequest req)
                                                                      throws TencentCloudSDKException
```
    本接口（DescribeApiEnvironmentStrategy）用于展示API绑定的限流策略。
    
    Parameters:
    
    req - DescribeApiEnvironmentStrategyRequest
    
    Returns:
    
    DescribeApiEnvironmentStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiForApiApp
```
public DescribeApiForApiAppResponse DescribeApiForApiApp(DescribeApiForApiAppRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（DescribeApiForApiApp）用于应用使用者查询部署于 API 网关的 API 接口的详细信息。
    
    Parameters:
    
    req - DescribeApiForApiAppRequest
    
    Returns:
    
    DescribeApiForApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiKey
```
public DescribeApiKeyResponse DescribeApiKey(DescribeApiKeyRequest req)
                                      throws TencentCloudSDKException
```
    本接口（DescribeApiKey）用于查询密钥详情。用户在创建密钥后，可用此接口查询一个 API 密钥的详情，该接口会显示密钥 Key。
    
    Parameters:
    
    req - DescribeApiKeyRequest
    
    Returns:
    
    DescribeApiKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiKeysStatus
```
public DescribeApiKeysStatusResponse DescribeApiKeysStatus(DescribeApiKeysStatusRequest req)
                                                    throws TencentCloudSDKException
```
    本接口（DescribeApiKeysStatus）用于查询密钥列表。当用户创建了多个密钥对时，可使用本接口查询一个或多个 API 密钥信息。
    
    Parameters:
    
    req - DescribeApiKeysStatusRequest
    
    Returns:
    
    DescribeApiKeysStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApiUsagePlan
```
public DescribeApiUsagePlanResponse DescribeApiUsagePlan(DescribeApiUsagePlanRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（DescribeApiUsagePlan）用于查询服务中 API 使用计划详情。服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务及其中 API 的所有使用计划。
    
    Parameters:
    
    req - DescribeApiUsagePlanRequest
    
    Returns:
    
    DescribeApiUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApisStatus
```
public DescribeApisStatusResponse DescribeApisStatus(DescribeApisStatusRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DescribeApisStatus）用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。
    
    Parameters:
    
    req - DescribeApisStatusRequest
    
    Returns:
    
    DescribeApisStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeExclusiveInstanceDetail
```
public DescribeExclusiveInstanceDetailResponse DescribeExclusiveInstanceDetail(DescribeExclusiveInstanceDetailRequest req)
                                                                        throws TencentCloudSDKException
```
    本接口（DescribeExclusiveInstanceDetail）用于查询独享实例详情信息。
    
    Parameters:
    
    req - DescribeExclusiveInstanceDetailRequest
    
    Returns:
    
    DescribeExclusiveInstanceDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeExclusiveInstanceRegions
```
public DescribeExclusiveInstanceRegionsResponse DescribeExclusiveInstanceRegions(DescribeExclusiveInstanceRegionsRequest req)
                                                                          throws TencentCloudSDKException
```
    Get the list of supported regions for dedicated instances
    
    Parameters:
    
    req - DescribeExclusiveInstanceRegionsRequest
    
    Returns:
    
    DescribeExclusiveInstanceRegionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeExclusiveInstances
```
public DescribeExclusiveInstancesResponse DescribeExclusiveInstances(DescribeExclusiveInstancesRequest req)
                                                              throws TencentCloudSDKException
```
    本接口（DescribeExclusiveInstances）用于查询独享实例列表信息。
    
    Parameters:
    
    req - DescribeExclusiveInstancesRequest
    
    Returns:
    
    DescribeExclusiveInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeExclusiveInstancesStatus
```
public DescribeExclusiveInstancesStatusResponse DescribeExclusiveInstancesStatus(DescribeExclusiveInstancesStatusRequest req)
                                                                          throws TencentCloudSDKException
```
    查询专享实例列表（新）
    
    Parameters:
    
    req - DescribeExclusiveInstancesStatusRequest
    
    Returns:
    
    DescribeExclusiveInstancesStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIPStrategy
```
public DescribeIPStrategyResponse DescribeIPStrategy(DescribeIPStrategyRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DescribeIPStrategy）用于查询IP策略详情。
    
    Parameters:
    
    req - DescribeIPStrategyRequest
    
    Returns:
    
    DescribeIPStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIPStrategyApisStatus
```
public DescribeIPStrategyApisStatusResponse DescribeIPStrategyApisStatus(DescribeIPStrategyApisStatusRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口（DescribeIPStrategyApisStatus）用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。
    
    Parameters:
    
    req - DescribeIPStrategyApisStatusRequest
    
    Returns:
    
    DescribeIPStrategyApisStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIPStrategysStatus
```
public DescribeIPStrategysStatusResponse DescribeIPStrategysStatus(DescribeIPStrategysStatusRequest req)
                                                            throws TencentCloudSDKException
```
    本接口（DescribeIPStrategysStatus）用于查询服务IP策略列表，因为接口名拼写错误，已不推荐使用，请优先使用DescribeIPStrategiesStatus接口。
    
    Parameters:
    
    req - DescribeIPStrategysStatusRequest
    
    Returns:
    
    DescribeIPStrategysStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstancesNetworkConfig
```
public DescribeInstancesNetworkConfigResponse DescribeInstancesNetworkConfig(DescribeInstancesNetworkConfigRequest req)
                                                                      throws TencentCloudSDKException
```
    获取专享实例网络配置列表
    
    Parameters:
    
    req - DescribeInstancesNetworkConfigRequest
    
    Returns:
    
    DescribeInstancesNetworkConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLogSearch
```
public DescribeLogSearchResponse DescribeLogSearch(DescribeLogSearchRequest req)
                                            throws TencentCloudSDKException
```
    本接口DescribeLogSearch用于搜索日志
    
    Parameters:
    
    req - DescribeLogSearchRequest
    
    Returns:
    
    DescribeLogSearchResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePlugin
```
public DescribePluginResponse DescribePlugin(DescribePluginRequest req)
                                      throws TencentCloudSDKException
```
    展示插件详情，支持按照插件ID进行。
    
    Parameters:
    
    req - DescribePluginRequest
    
    Returns:
    
    DescribePluginResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePluginApis
```
public DescribePluginApisResponse DescribePluginApis(DescribePluginApisRequest req)
                                              throws TencentCloudSDKException
```
    查询指定插件下绑定的API信息
    
    Parameters:
    
    req - DescribePluginApisRequest
    
    Returns:
    
    DescribePluginApisResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePlugins
```
public DescribePluginsResponse DescribePlugins(DescribePluginsRequest req)
                                        throws TencentCloudSDKException
```
    展示插件列表和详情，支持分页，支持按照插件类型查询，支持按照插件ID批量查询，支持按照插件名称查询。
    
    Parameters:
    
    req - DescribePluginsRequest
    
    Returns:
    
    DescribePluginsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePluginsByApi
```
public DescribePluginsByApiResponse DescribePluginsByApi(DescribePluginsByApiRequest req)
                                                  throws TencentCloudSDKException
```
    展示API上已绑定的插件列表。
    
    Parameters:
    
    req - DescribePluginsByApiRequest
    
    Returns:
    
    DescribePluginsByApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeService
```
public DescribeServiceResponse DescribeService(DescribeServiceRequest req)
                                        throws TencentCloudSDKException
```
    本接口（DescribeService）用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。
    
    Parameters:
    
    req - DescribeServiceRequest
    
    Returns:
    
    DescribeServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceEnvironmentList
```
public DescribeServiceEnvironmentListResponse DescribeServiceEnvironmentList(DescribeServiceEnvironmentListRequest req)
                                                                      throws TencentCloudSDKException
```
    本接口（DescribeServiceEnvironmentList）用于查询一个服务的环境列表，可查询到此服务下所有环境及其状态。
    
    Parameters:
    
    req - DescribeServiceEnvironmentListRequest
    
    Returns:
    
    DescribeServiceEnvironmentListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceEnvironmentReleaseHistory
```
public DescribeServiceEnvironmentReleaseHistoryResponse DescribeServiceEnvironmentReleaseHistory(DescribeServiceEnvironmentReleaseHistoryRequest req)
                                                                                          throws TencentCloudSDKException
```
    本接口（DescribeServiceEnvironmentReleaseHistory）用于查询服务环境的发布历史。用户在创建好服务后需要发布到某个环境中才能进行使用，本接口用于查询一个服务某个环境的发布记录。
    
    Parameters:
    
    req - DescribeServiceEnvironmentReleaseHistoryRequest
    
    Returns:
    
    DescribeServiceEnvironmentReleaseHistoryResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceEnvironmentStrategy
```
public DescribeServiceEnvironmentStrategyResponse DescribeServiceEnvironmentStrategy(DescribeServiceEnvironmentStrategyRequest req)
                                                                              throws TencentCloudSDKException
```
    本接口（DescribeServiceEnvironmentStrategy）用于展示服务限流策略。
    
    Parameters:
    
    req - DescribeServiceEnvironmentStrategyRequest
    
    Returns:
    
    DescribeServiceEnvironmentStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceForApiApp
```
public DescribeServiceForApiAppResponse DescribeServiceForApiApp(DescribeServiceForApiAppRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（DescribeServiceForApiApp）用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。
    
    Parameters:
    
    req - DescribeServiceForApiAppRequest
    
    Returns:
    
    DescribeServiceForApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceReleaseVersion
```
public DescribeServiceReleaseVersionResponse DescribeServiceReleaseVersion(DescribeServiceReleaseVersionRequest req)
                                                                    throws TencentCloudSDKException
```
    本接口（DescribeServiceReleaseVersion）查询一个服务下面所有已经发布的版本列表。用户在发布服务时，常有多个版本发布，可使用本接口查询已发布的版本。
    
    Parameters:
    
    req - DescribeServiceReleaseVersionRequest
    
    Returns:
    
    DescribeServiceReleaseVersionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceSubDomainMappings
```
public DescribeServiceSubDomainMappingsResponse DescribeServiceSubDomainMappings(DescribeServiceSubDomainMappingsRequest req)
                                                                          throws TencentCloudSDKException
```
    本接口（DescribeServiceSubDomainMappings）用于查询自定义域名的路径映射。 API 网关可绑定自定义域名到服务，并且可以对自定义域名的路径进行映射，可自定义不同的路径映射到服务中的三个环境，本接口用于查询绑定服务的自定义域名的路径映射列表。
    
    Parameters:
    
    req - DescribeServiceSubDomainMappingsRequest
    
    Returns:
    
    DescribeServiceSubDomainMappingsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceSubDomains
```
public DescribeServiceSubDomainsResponse DescribeServiceSubDomains(DescribeServiceSubDomainsRequest req)
                                                            throws TencentCloudSDKException
```
    本接口（DescribeServiceSubDomains）用于查询自定义域名列表。 API 网关可绑定自定义域名到服务，用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。
    
    Parameters:
    
    req - DescribeServiceSubDomainsRequest
    
    Returns:
    
    DescribeServiceSubDomainsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServiceUsagePlan
```
public DescribeServiceUsagePlanResponse DescribeServiceUsagePlan(DescribeServiceUsagePlanRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（DescribeServiceUsagePlan）用于查询服务使用计划详情。服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务的所有使用计划。
    
    Parameters:
    
    req - DescribeServiceUsagePlanRequest
    
    Returns:
    
    DescribeServiceUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeServicesStatus
```
public DescribeServicesStatusResponse DescribeServicesStatus(DescribeServicesStatusRequest req)
                                                      throws TencentCloudSDKException
```
    本接口（DescribeServicesStatus）用于搜索查询某一个服务或多个服务的列表，并返回服务相关的域名、时间等信息。
    
    Parameters:
    
    req - DescribeServicesStatusRequest
    
    Returns:
    
    DescribeServicesStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUpstreamBindApis
```
public DescribeUpstreamBindApisResponse DescribeUpstreamBindApis(DescribeUpstreamBindApisRequest req)
                                                          throws TencentCloudSDKException
```
    查询后端通道所绑定的API列表
    
    Parameters:
    
    req - DescribeUpstreamBindApisRequest
    
    Returns:
    
    DescribeUpstreamBindApisResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUpstreams
```
public DescribeUpstreamsResponse DescribeUpstreams(DescribeUpstreamsRequest req)
                                            throws TencentCloudSDKException
```
    查询后端通道列表详情
    
    Parameters:
    
    req - DescribeUpstreamsRequest
    
    Returns:
    
    DescribeUpstreamsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsagePlan
```
public DescribeUsagePlanResponse DescribeUsagePlan(DescribeUsagePlanRequest req)
                                            throws TencentCloudSDKException
```
    本接口（DescribeUsagePlan）用于查询一个使用计划的详细信息，包括名称、QPS、创建时间绑定的环境等。
    
    Parameters:
    
    req - DescribeUsagePlanRequest
    
    Returns:
    
    DescribeUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsagePlanEnvironments
```
public DescribeUsagePlanEnvironmentsResponse DescribeUsagePlanEnvironments(DescribeUsagePlanEnvironmentsRequest req)
                                                                    throws TencentCloudSDKException
```
    本接口（DescribeUsagePlanEnvironments）用于查询使用计划绑定的环境列表。用户在绑定了某个使用计划到环境后，可使用本接口查询这个使用计划绑定的所有服务的环境。
    
    Parameters:
    
    req - DescribeUsagePlanEnvironmentsRequest
    
    Returns:
    
    DescribeUsagePlanEnvironmentsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsagePlanSecretIds
```
public DescribeUsagePlanSecretIdsResponse DescribeUsagePlanSecretIds(DescribeUsagePlanSecretIdsRequest req)
                                                              throws TencentCloudSDKException
```
    本接口（DescribeUsagePlanSecretIds）用于查询使用计划绑定的密钥列表。在 API 网关中，一个使用计划可绑定多个密钥对，可使用本接口查询使用计划绑定的密钥列表。
    
    Parameters:
    
    req - DescribeUsagePlanSecretIdsRequest
    
    Returns:
    
    DescribeUsagePlanSecretIdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsagePlansStatus
```
public DescribeUsagePlansStatusResponse DescribeUsagePlansStatus(DescribeUsagePlansStatusRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（DescribeUsagePlanStatus）用于查询使用计划的列表。
    
    Parameters:
    
    req - DescribeUsagePlansStatusRequest
    
    Returns:
    
    DescribeUsagePlansStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetachPlugin
```
public DetachPluginResponse DetachPlugin(DetachPluginRequest req)
                                  throws TencentCloudSDKException
```
    解除插件与API绑定
    
    Parameters:
    
    req - DetachPluginRequest
    
    Returns:
    
    DetachPluginResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableApiKey
```
public DisableApiKeyResponse DisableApiKey(DisableApiKeyRequest req)
                                    throws TencentCloudSDKException
```
    本接口（DisableApiKey）用于禁用一对 API 密钥。
    
    Parameters:
    
    req - DisableApiKeyRequest
    
    Returns:
    
    DisableApiKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableApiKey
```
public EnableApiKeyResponse EnableApiKey(EnableApiKeyRequest req)
                                  throws TencentCloudSDKException
```
    本接口（EnableApiKey）用于启动一对被禁用的 API 密钥。
    
    Parameters:
    
    req - EnableApiKeyRequest
    
    Returns:
    
    EnableApiKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ImportOpenApi
```
public ImportOpenApiResponse ImportOpenApi(ImportOpenApiRequest req)
                                    throws TencentCloudSDKException
```
    本接口（ImportOpenApi）用于将OpenAPI规范定义的API导入到API网关。
    
    Parameters:
    
    req - ImportOpenApiRequest
    
    Returns:
    
    ImportOpenApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyAPIDoc
```
public ModifyAPIDocResponse ModifyAPIDoc(ModifyAPIDocRequest req)
                                  throws TencentCloudSDKException
```
    修改 API 文档
    
    Parameters:
    
    req - ModifyAPIDocRequest
    
    Returns:
    
    ModifyAPIDocResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApi
```
public ModifyApiResponse ModifyApi(ModifyApiRequest req)
                            throws TencentCloudSDKException
```
    本接口（ModifyApi）用于修改 API 接口，可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。
    
    Parameters:
    
    req - ModifyApiRequest
    
    Returns:
    
    ModifyApiResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApiApp
```
public ModifyApiAppResponse ModifyApiApp(ModifyApiAppRequest req)
                                  throws TencentCloudSDKException
```
    本接口（ModifyApiApp）用于修改已经创建的应用。
    
    Parameters:
    
    req - ModifyApiAppRequest
    
    Returns:
    
    ModifyApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApiEnvironmentStrategy
```
public ModifyApiEnvironmentStrategyResponse ModifyApiEnvironmentStrategy(ModifyApiEnvironmentStrategyRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口（ModifyApiEnvironmentStrategy）用于修改API限流策略
    
    Parameters:
    
    req - ModifyApiEnvironmentStrategyRequest
    
    Returns:
    
    ModifyApiEnvironmentStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApiIncrement
```
public ModifyApiIncrementResponse ModifyApiIncrement(ModifyApiIncrementRequest req)
                                              throws TencentCloudSDKException
```
    提供增量更新API能力，主要是给程序调用（区别于ModifyApi，该接口是需要传入API的全量参数，对console使用较友好）
    
    Parameters:
    
    req - ModifyApiIncrementRequest
    
    Returns:
    
    ModifyApiIncrementResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyExclusiveInstance
```
public ModifyExclusiveInstanceResponse ModifyExclusiveInstance(ModifyExclusiveInstanceRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（ModifyExclusiveInstance）用于修改独享实例信息。
    
    Parameters:
    
    req - ModifyExclusiveInstanceRequest
    
    Returns:
    
    ModifyExclusiveInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyIPStrategy
```
public ModifyIPStrategyResponse ModifyIPStrategy(ModifyIPStrategyRequest req)
                                          throws TencentCloudSDKException
```
    本接口（ModifyIPStrategy）用于修改服务IP策略。
    
    Parameters:
    
    req - ModifyIPStrategyRequest
    
    Returns:
    
    ModifyIPStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPlugin
```
public ModifyPluginResponse ModifyPlugin(ModifyPluginRequest req)
                                  throws TencentCloudSDKException
```
    修改API网关插件。
    
    Parameters:
    
    req - ModifyPluginRequest
    
    Returns:
    
    ModifyPluginResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyService
```
public ModifyServiceResponse ModifyService(ModifyServiceRequest req)
                                    throws TencentCloudSDKException
```
    本接口（ModifyService）用于修改服务的相关信息。当服务创建后，服务的名称、描述和服务类型均可被修改。
    
    Parameters:
    
    req - ModifyServiceRequest
    
    Returns:
    
    ModifyServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyServiceEnvironmentStrategy
```
public ModifyServiceEnvironmentStrategyResponse ModifyServiceEnvironmentStrategy(ModifyServiceEnvironmentStrategyRequest req)
                                                                          throws TencentCloudSDKException
```
    本接口（ModifyServiceEnvironmentStrategy）用于修改服务限流策略
    
    Parameters:
    
    req - ModifyServiceEnvironmentStrategyRequest
    
    Returns:
    
    ModifyServiceEnvironmentStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySubDomain
```
public ModifySubDomainResponse ModifySubDomain(ModifySubDomainRequest req)
                                        throws TencentCloudSDKException
```
    本接口（ModifySubDomain）用于修改服务的自定义域名设置中的路径映射，可以修改绑定自定义域名之前的路径映射规则。
    
    Parameters:
    
    req - ModifySubDomainRequest
    
    Returns:
    
    ModifySubDomainResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyUpstream
```
public ModifyUpstreamResponse ModifyUpstream(ModifyUpstreamRequest req)
                                      throws TencentCloudSDKException
```
    修改后端通道
    
    Parameters:
    
    req - ModifyUpstreamRequest
    
    Returns:
    
    ModifyUpstreamResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyUsagePlan
```
public ModifyUsagePlanResponse ModifyUsagePlan(ModifyUsagePlanRequest req)
                                        throws TencentCloudSDKException
```
    本接口（ModifyUsagePlan）用于修改使用计划的名称，描述及 QPS。
    
    Parameters:
    
    req - ModifyUsagePlanRequest
    
    Returns:
    
    ModifyUsagePlanResponse
    
    Throws:
    
    TencentCloudSDKException
  - ReleaseService
```
public ReleaseServiceResponse ReleaseService(ReleaseServiceRequest req)
                                      throws TencentCloudSDKException
```
    本接口（ReleaseService）用于发布服务。 API 网关的服务创建后，需要发布到某个环境方生效后，使用者才能进行调用，此接口用于发布服务到环境，如 release 环境。
    
    Parameters:
    
    req - ReleaseServiceRequest
    
    Returns:
    
    ReleaseServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetAPIDocPassword
```
public ResetAPIDocPasswordResponse ResetAPIDocPassword(ResetAPIDocPasswordRequest req)
                                                throws TencentCloudSDKException
```
    重置API文档密码
    
    Parameters:
    
    req - ResetAPIDocPasswordRequest
    
    Returns:
    
    ResetAPIDocPasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnBindEnvironment
```
public UnBindEnvironmentResponse UnBindEnvironment(UnBindEnvironmentRequest req)
                                            throws TencentCloudSDKException
```
    本接口（UnBindEnvironment）用于将使用计划从特定环境解绑。
    
    Parameters:
    
    req - UnBindEnvironmentRequest
    
    Returns:
    
    UnBindEnvironmentResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnBindIPStrategy
```
public UnBindIPStrategyResponse UnBindIPStrategy(UnBindIPStrategyRequest req)
                                          throws TencentCloudSDKException
```
    本接口（UnBindIPStrategy）用于服务解绑IP策略。
    
    Parameters:
    
    req - UnBindIPStrategyRequest
    
    Returns:
    
    UnBindIPStrategyResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnBindSecretIds
```
public UnBindSecretIdsResponse UnBindSecretIds(UnBindSecretIdsRequest req)
                                        throws TencentCloudSDKException
```
    本接口（UnBindSecretIds）用于为使用计划解绑密钥。
    
    Parameters:
    
    req - UnBindSecretIdsRequest
    
    Returns:
    
    UnBindSecretIdsResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnBindSubDomain
```
public UnBindSubDomainResponse UnBindSubDomain(UnBindSubDomainRequest req)
                                        throws TencentCloudSDKException
```
    本接口（UnBindSubDomain）用于解绑自定义域名。用户使用 API 网关绑定了自定义域名到服务中后，若想要解绑此自定义域名，可使用此接口。
    
    Parameters:
    
    req - UnBindSubDomainRequest
    
    Returns:
    
    UnBindSubDomainResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnReleaseService
```
public UnReleaseServiceResponse UnReleaseService(UnReleaseServiceRequest req)
                                          throws TencentCloudSDKException
```
    本接口（UnReleaseService）用于下线服务。用户发布服务到某个环境后，此服务中的 API 方可被调用者进行调用，当用户需要将此服务从发布环境中下线时，可调用此 API。下线后的服务不可被调用。
    
    Parameters:
    
    req - UnReleaseServiceRequest
    
    Returns:
    
    UnReleaseServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindApiApp
```
public UnbindApiAppResponse UnbindApiApp(UnbindApiAppRequest req)
                                  throws TencentCloudSDKException
```
    本接口（UnbindApiApp）用于解除应用和API绑定。
    
    Parameters:
    
    req - UnbindApiAppRequest
    
    Returns:
    
    UnbindApiAppResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateApiAppKey
```
public UpdateApiAppKeyResponse UpdateApiAppKey(UpdateApiAppKeyRequest req)
                                        throws TencentCloudSDKException
```
    本接口（UpdateApiAppKey）用于更新应用密钥。
    
    Parameters:
    
    req - UpdateApiAppKeyRequest
    
    Returns:
    
    UpdateApiAppKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateApiKey
```
public UpdateApiKeyResponse UpdateApiKey(UpdateApiKeyRequest req)
                                  throws TencentCloudSDKException
```
    本接口（UpdateApiKey）用于更换用户已创建的一对 API 密钥。
    
    Parameters:
    
    req - UpdateApiKeyRequest
    
    Returns:
    
    UpdateApiKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateService
```
public UpdateServiceResponse UpdateService(UpdateServiceRequest req)
                                    throws TencentCloudSDKException
```
    本接口（UpdateService）用于从服务已发布的环境中将运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后，如在开发过程产生多个版本需要切换，此时可调用本接口。
    
    Parameters:
    
    req - UpdateServiceRequest
    
    Returns:
    
    UpdateServiceResponse
    
    Throws:
    
    TencentCloudSDKException

Class ApigatewayClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

ApigatewayClient

ApigatewayClient

Method Detail

AttachPlugin

BindApiApp

BindEnvironment

BindIPStrategy

BindSecretIds

BindSubDomain

BuildAPIDoc

CreateAPIDoc

CreateApi

CreateApiApp

CreateApiKey

CreateExclusiveInstances

CreateIPStrategy

CreatePlugin

CreateService

CreateUpstream

CreateUsagePlan

DeleteAPIDoc

DeleteApi

DeleteApiApp

DeleteApiKey

DeleteIPStrategy

DeletePlugin

DeleteService

DeleteServiceSubDomainMapping

DeleteUpstream

DeleteUsagePlan

DemoteServiceUsagePlan

DescribeAPIDocDetail

DescribeAPIDocs

DescribeAllPluginApis

DescribeApi

DescribeApiApp

DescribeApiAppBindApisStatus

DescribeApiAppsStatus

DescribeApiBindApiAppsStatus

DescribeApiEnvironmentStrategy

DescribeApiForApiApp

DescribeApiKey

DescribeApiKeysStatus

DescribeApiUsagePlan

DescribeApisStatus

DescribeExclusiveInstanceDetail

DescribeExclusiveInstanceRegions

DescribeExclusiveInstances

DescribeExclusiveInstancesStatus

DescribeIPStrategy

DescribeIPStrategyApisStatus

DescribeIPStrategysStatus

DescribeInstancesNetworkConfig

DescribeLogSearch

DescribePlugin

DescribePluginApis

DescribePlugins

DescribePluginsByApi

DescribeService

DescribeServiceEnvironmentList

DescribeServiceEnvironmentReleaseHistory

DescribeServiceEnvironmentStrategy

DescribeServiceForApiApp

DescribeServiceReleaseVersion

DescribeServiceSubDomainMappings

DescribeServiceSubDomains

DescribeServiceUsagePlan

DescribeServicesStatus

DescribeUpstreamBindApis

DescribeUpstreams

DescribeUsagePlan

DescribeUsagePlanEnvironments