tencentcloud 1.82.35, Nov 7 25

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getApiGatewayApiAppApi

Start a Neo task

Explain and create a tencentcloud.getApiGatewayApiAppApi resource

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const example = tencentcloud.getApiGatewayApiAppApi({
    serviceId: "service-nxz6yync",
    apiId: "api-0cvmf4x4",
    apiRegion: "ap-guangzhou",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_api_gateway_api_app_api(service_id="service-nxz6yync",
    api_id="api-0cvmf4x4",
    api_region="ap-guangzhou")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.LookupApiGatewayApiAppApi(ctx, &tencentcloud.LookupApiGatewayApiAppApiArgs{
			ServiceId: "service-nxz6yync",
			ApiId:     "api-0cvmf4x4",
			ApiRegion: "ap-guangzhou",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetApiGatewayApiAppApi.Invoke(new()
    {
        ServiceId = "service-nxz6yync",
        ApiId = "api-0cvmf4x4",
        ApiRegion = "ap-guangzhou",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetApiGatewayApiAppApiArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = TencentcloudFunctions.getApiGatewayApiAppApi(GetApiGatewayApiAppApiArgs.builder()
            .serviceId("service-nxz6yync")
            .apiId("api-0cvmf4x4")
            .apiRegion("ap-guangzhou")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getApiGatewayApiAppApi
      arguments:
        serviceId: service-nxz6yync
        apiId: api-0cvmf4x4
        apiRegion: ap-guangzhou

Using getApiGatewayApiAppApi

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiGatewayApiAppApi(args: GetApiGatewayApiAppApiArgs, opts?: InvokeOptions): Promise<GetApiGatewayApiAppApiResult>
function getApiGatewayApiAppApiOutput(args: GetApiGatewayApiAppApiOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayApiAppApiResult>

def get_api_gateway_api_app_api(api_id: Optional[str] = None,
                                api_region: Optional[str] = None,
                                id: Optional[str] = None,
                                result_output_file: Optional[str] = None,
                                service_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetApiGatewayApiAppApiResult
def get_api_gateway_api_app_api_output(api_id: Optional[pulumi.Input[str]] = None,
                                api_region: Optional[pulumi.Input[str]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                result_output_file: Optional[pulumi.Input[str]] = None,
                                service_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayApiAppApiResult]

func LookupApiGatewayApiAppApi(ctx *Context, args *LookupApiGatewayApiAppApiArgs, opts ...InvokeOption) (*LookupApiGatewayApiAppApiResult, error)
func LookupApiGatewayApiAppApiOutput(ctx *Context, args *LookupApiGatewayApiAppApiOutputArgs, opts ...InvokeOption) LookupApiGatewayApiAppApiResultOutput

> Note: This function is named LookupApiGatewayApiAppApi in the Go SDK.

public static class GetApiGatewayApiAppApi 
{
    public static Task<GetApiGatewayApiAppApiResult> InvokeAsync(GetApiGatewayApiAppApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayApiAppApiResult> Invoke(GetApiGatewayApiAppApiInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiGatewayApiAppApiResult> getApiGatewayApiAppApi(GetApiGatewayApiAppApiArgs args, InvokeOptions options)
public static Output<GetApiGatewayApiAppApiResult> getApiGatewayApiAppApi(GetApiGatewayApiAppApiArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getApiGatewayApiAppApi:getApiGatewayApiAppApi
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiId string: API interface unique ID.
ApiRegion string: Api region.
ServiceId string: The unique ID of the service where the API resides.
Id string
ResultOutputFile string: Used to save apiAppApis.

ApiId string: API interface unique ID.
ApiRegion string: Api region.
ServiceId string: The unique ID of the service where the API resides.
Id string
ResultOutputFile string: Used to save apiAppApis.

apiId String: API interface unique ID.
apiRegion String: Api region.
serviceId String: The unique ID of the service where the API resides.
id String
resultOutputFile String: Used to save apiAppApis.

apiId string: API interface unique ID.
apiRegion string: Api region.
serviceId string: The unique ID of the service where the API resides.
id string
resultOutputFile string: Used to save apiAppApis.

api_id str: API interface unique ID.
api_region str: Api region.
service_id str: The unique ID of the service where the API resides.
id str
result_output_file str: Used to save apiAppApis.

apiId String: API interface unique ID.
apiRegion String: Api region.
serviceId String: The unique ID of the service where the API resides.
id String
resultOutputFile String: Used to save apiAppApis.

getApiGatewayApiAppApi Result

The following output properties are available:

ApiId string: API interface unique ID.
ApiRegion string
Id string
Results List<GetApiGatewayApiAppApiResult>: API details.
ServiceId string: The unique ID of the service where the API resides.
ResultOutputFile string

ApiId string: API interface unique ID.
ApiRegion string
Id string
Results []GetApiGatewayApiAppApiResult: API details.
ServiceId string: The unique ID of the service where the API resides.
ResultOutputFile string

apiId String: API interface unique ID.
apiRegion String
id String
results List<GetApiGatewayApiAppApiResult>: API details.
serviceId String: The unique ID of the service where the API resides.
resultOutputFile String

apiId string: API interface unique ID.
apiRegion string
id string
results GetApiGatewayApiAppApiResult[]: API details.
serviceId string: The unique ID of the service where the API resides.
resultOutputFile string

api_id str: API interface unique ID.
api_region str
id str
results Sequence[GetApiGatewayApiAppApiResult]: API details.
service_id str: The unique ID of the service where the API resides.
result_output_file str

apiId String: API interface unique ID.
apiRegion String
id String
results List<Property Map>: API details.
serviceId String: The unique ID of the service where the API resides.
resultOutputFile String

Supporting Types

GetApiGatewayApiAppApiResult

ApiBusinessType string: Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API).
ApiDesc string: Description of the API interface.
ApiId string: API interface unique ID.
ApiName string: The name of the API interface.
ApiType string: API type. Possible values are NORMAL (normal API) and TSF (microservice API).
AuthRelationApiId string: OAUTH The unique ID of the authorization API associated with the business API.
AuthType string: API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH.
Base64EncodedTriggerRules List<GetApiGatewayApiAppApiResultBase64EncodedTriggerRule>: Header triggers rules, and the total number of rules does not exceed 10.
ConstantParameters List<GetApiGatewayApiAppApiResultConstantParameter>: Constant parameters.
CreatedTime string: Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
EnableCors bool: Whether to enable cross-domain.
Environments List<string>: API published environment information.
InternalDomain string: WEBSOCKET pushback address.
IsBase64Encoded bool: Whether to enable Base64 encoding will only take effect when the backend is scf.
IsBase64Trigger bool: Whether to enable Base64-encoded header triggering will only take effect when the backend is scf.
IsDebugAfterCharge bool: Whether to debug after purchase (parameters reserved in the cloud market).
MicroServices List<GetApiGatewayApiAppApiResultMicroService>: API binding microservice list.
MicroServicesInfos List<double>: Microservice information details.
ModifiedTime string: Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
OauthConfigs List<GetApiGatewayApiAppApiResultOauthConfig>: OAUTH configuration.
Protocol string: The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS.
RequestConfigs List<GetApiGatewayApiAppApiResultRequestConfig>: The requested frontend configuration.
RequestParameters List<GetApiGatewayApiAppApiResultRequestParameter>: Front-end request parameters.
ResponseErrorCodes List<GetApiGatewayApiAppApiResultResponseErrorCode>: User-defined error code configuration.
ResponseFailExample string: Custom response configuration failure response example.
ResponseSuccessExample string: Custom response configuration successful response example.
ResponseType string: Return type.
ServiceConfigs List<GetApiGatewayApiAppApiResultServiceConfig>: Backend service configuration for the API.
ServiceDesc string: A description of the service where the API resides.
ServiceId string: The unique ID of the service where the API resides.
ServiceMockReturnMessage string: APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed.
ServiceName string: The name of the service where the API resides.
ServiceParameters List<GetApiGatewayApiAppApiResultServiceParameter>: API backend service parameters.
ServiceScfFunctionName string: Scf function name. Effective when the backend type is SCF.
ServiceScfFunctionNamespace string: Scf function namespace. Effective when the backend type is SCF.
ServiceScfFunctionQualifier string: Scf function version. Effective when the backend type is SCF.
ServiceScfIsIntegratedResponse bool: Whether to enable integrated response.
ServiceTimeout double: The backend service timeout of the API, in seconds.
ServiceTsfHealthCheckConfs List<GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf>: Health check configuration for microservices.
ServiceTsfLoadBalanceConfs List<GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf>: Load balancing configuration for microservices.
ServiceType string: The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing).
ServiceWebsocketCleanupFunctionName string: Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketCleanupFunctionNamespace string: Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketCleanupFunctionQualifier string: Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketRegisterFunctionName string: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketRegisterFunctionNamespace string: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketRegisterFunctionQualifier string: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketTransportFunctionName string: Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketTransportFunctionNamespace string: Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketTransportFunctionQualifier string: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
Tags List<GetApiGatewayApiAppApiResultTag>: API binding tag information.

ApiBusinessType string: Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API).
ApiDesc string: Description of the API interface.
ApiId string: API interface unique ID.
ApiName string: The name of the API interface.
ApiType string: API type. Possible values are NORMAL (normal API) and TSF (microservice API).
AuthRelationApiId string: OAUTH The unique ID of the authorization API associated with the business API.
AuthType string: API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH.
Base64EncodedTriggerRules []GetApiGatewayApiAppApiResultBase64EncodedTriggerRule: Header triggers rules, and the total number of rules does not exceed 10.
ConstantParameters []GetApiGatewayApiAppApiResultConstantParameter: Constant parameters.
CreatedTime string: Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
EnableCors bool: Whether to enable cross-domain.
Environments []string: API published environment information.
InternalDomain string: WEBSOCKET pushback address.
IsBase64Encoded bool: Whether to enable Base64 encoding will only take effect when the backend is scf.
IsBase64Trigger bool: Whether to enable Base64-encoded header triggering will only take effect when the backend is scf.
IsDebugAfterCharge bool: Whether to debug after purchase (parameters reserved in the cloud market).
MicroServices []GetApiGatewayApiAppApiResultMicroService: API binding microservice list.
MicroServicesInfos []float64: Microservice information details.
ModifiedTime string: Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
OauthConfigs []GetApiGatewayApiAppApiResultOauthConfig: OAUTH configuration.
Protocol string: The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS.
RequestConfigs []GetApiGatewayApiAppApiResultRequestConfig: The requested frontend configuration.
RequestParameters []GetApiGatewayApiAppApiResultRequestParameter: Front-end request parameters.
ResponseErrorCodes []GetApiGatewayApiAppApiResultResponseErrorCode: User-defined error code configuration.
ResponseFailExample string: Custom response configuration failure response example.
ResponseSuccessExample string: Custom response configuration successful response example.
ResponseType string: Return type.
ServiceConfigs []GetApiGatewayApiAppApiResultServiceConfig: Backend service configuration for the API.
ServiceDesc string: A description of the service where the API resides.
ServiceId string: The unique ID of the service where the API resides.
ServiceMockReturnMessage string: APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed.
ServiceName string: The name of the service where the API resides.
ServiceParameters []GetApiGatewayApiAppApiResultServiceParameter: API backend service parameters.
ServiceScfFunctionName string: Scf function name. Effective when the backend type is SCF.
ServiceScfFunctionNamespace string: Scf function namespace. Effective when the backend type is SCF.
ServiceScfFunctionQualifier string: Scf function version. Effective when the backend type is SCF.
ServiceScfIsIntegratedResponse bool: Whether to enable integrated response.
ServiceTimeout float64: The backend service timeout of the API, in seconds.
ServiceTsfHealthCheckConfs []GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf: Health check configuration for microservices.
ServiceTsfLoadBalanceConfs []GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf: Load balancing configuration for microservices.
ServiceType string: The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing).
ServiceWebsocketCleanupFunctionName string: Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketCleanupFunctionNamespace string: Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketCleanupFunctionQualifier string: Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketRegisterFunctionName string: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketRegisterFunctionNamespace string: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketRegisterFunctionQualifier string: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketTransportFunctionName string: Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketTransportFunctionNamespace string: Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
ServiceWebsocketTransportFunctionQualifier string: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
Tags []GetApiGatewayApiAppApiResultTag: API binding tag information.

apiBusinessType String: Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API).
apiDesc String: Description of the API interface.
apiId String: API interface unique ID.
apiName String: The name of the API interface.
apiType String: API type. Possible values are NORMAL (normal API) and TSF (microservice API).
authRelationApiId String: OAUTH The unique ID of the authorization API associated with the business API.
authType String: API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH.
base64EncodedTriggerRules List<GetApiGatewayApiAppApiResultBase64EncodedTriggerRule>: Header triggers rules, and the total number of rules does not exceed 10.
constantParameters List<GetApiGatewayApiAppApiResultConstantParameter>: Constant parameters.
createdTime String: Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
enableCors Boolean: Whether to enable cross-domain.
environments List<String>: API published environment information.
internalDomain String: WEBSOCKET pushback address.
isBase64Encoded Boolean: Whether to enable Base64 encoding will only take effect when the backend is scf.
isBase64Trigger Boolean: Whether to enable Base64-encoded header triggering will only take effect when the backend is scf.
isDebugAfterCharge Boolean: Whether to debug after purchase (parameters reserved in the cloud market).
microServices List<GetApiGatewayApiAppApiResultMicroService>: API binding microservice list.
microServicesInfos List<Double>: Microservice information details.
modifiedTime String: Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
oauthConfigs List<GetApiGatewayApiAppApiResultOauthConfig>: OAUTH configuration.
protocol String: The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS.
requestConfigs List<GetApiGatewayApiAppApiResultRequestConfig>: The requested frontend configuration.
requestParameters List<GetApiGatewayApiAppApiResultRequestParameter>: Front-end request parameters.
responseErrorCodes List<GetApiGatewayApiAppApiResultResponseErrorCode>: User-defined error code configuration.
responseFailExample String: Custom response configuration failure response example.
responseSuccessExample String: Custom response configuration successful response example.
responseType String: Return type.
serviceConfigs List<GetApiGatewayApiAppApiResultServiceConfig>: Backend service configuration for the API.
serviceDesc String: A description of the service where the API resides.
serviceId String: The unique ID of the service where the API resides.
serviceMockReturnMessage String: APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed.
serviceName String: The name of the service where the API resides.
serviceParameters List<GetApiGatewayApiAppApiResultServiceParameter>: API backend service parameters.
serviceScfFunctionName String: Scf function name. Effective when the backend type is SCF.
serviceScfFunctionNamespace String: Scf function namespace. Effective when the backend type is SCF.
serviceScfFunctionQualifier String: Scf function version. Effective when the backend type is SCF.
serviceScfIsIntegratedResponse Boolean: Whether to enable integrated response.
serviceTimeout Double: The backend service timeout of the API, in seconds.
serviceTsfHealthCheckConfs List<GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf>: Health check configuration for microservices.
serviceTsfLoadBalanceConfs List<GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf>: Load balancing configuration for microservices.
serviceType String: The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing).
serviceWebsocketCleanupFunctionName String: Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketCleanupFunctionNamespace String: Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketCleanupFunctionQualifier String: Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionName String: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionNamespace String: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionQualifier String: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionName String: Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionNamespace String: Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionQualifier String: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
tags List<GetApiGatewayApiAppApiResultTag>: API binding tag information.

apiBusinessType string: Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API).
apiDesc string: Description of the API interface.
apiId string: API interface unique ID.
apiName string: The name of the API interface.
apiType string: API type. Possible values are NORMAL (normal API) and TSF (microservice API).
authRelationApiId string: OAUTH The unique ID of the authorization API associated with the business API.
authType string: API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH.
base64EncodedTriggerRules GetApiGatewayApiAppApiResultBase64EncodedTriggerRule[]: Header triggers rules, and the total number of rules does not exceed 10.
constantParameters GetApiGatewayApiAppApiResultConstantParameter[]: Constant parameters.
createdTime string: Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
enableCors boolean: Whether to enable cross-domain.
environments string[]: API published environment information.
internalDomain string: WEBSOCKET pushback address.
isBase64Encoded boolean: Whether to enable Base64 encoding will only take effect when the backend is scf.
isBase64Trigger boolean: Whether to enable Base64-encoded header triggering will only take effect when the backend is scf.
isDebugAfterCharge boolean: Whether to debug after purchase (parameters reserved in the cloud market).
microServices GetApiGatewayApiAppApiResultMicroService[]: API binding microservice list.
microServicesInfos number[]: Microservice information details.
modifiedTime string: Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
oauthConfigs GetApiGatewayApiAppApiResultOauthConfig[]: OAUTH configuration.
protocol string: The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS.
requestConfigs GetApiGatewayApiAppApiResultRequestConfig[]: The requested frontend configuration.
requestParameters GetApiGatewayApiAppApiResultRequestParameter[]: Front-end request parameters.
responseErrorCodes GetApiGatewayApiAppApiResultResponseErrorCode[]: User-defined error code configuration.
responseFailExample string: Custom response configuration failure response example.
responseSuccessExample string: Custom response configuration successful response example.
responseType string: Return type.
serviceConfigs GetApiGatewayApiAppApiResultServiceConfig[]: Backend service configuration for the API.
serviceDesc string: A description of the service where the API resides.
serviceId string: The unique ID of the service where the API resides.
serviceMockReturnMessage string: APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed.
serviceName string: The name of the service where the API resides.
serviceParameters GetApiGatewayApiAppApiResultServiceParameter[]: API backend service parameters.
serviceScfFunctionName string: Scf function name. Effective when the backend type is SCF.
serviceScfFunctionNamespace string: Scf function namespace. Effective when the backend type is SCF.
serviceScfFunctionQualifier string: Scf function version. Effective when the backend type is SCF.
serviceScfIsIntegratedResponse boolean: Whether to enable integrated response.
serviceTimeout number: The backend service timeout of the API, in seconds.
serviceTsfHealthCheckConfs GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf[]: Health check configuration for microservices.
serviceTsfLoadBalanceConfs GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf[]: Load balancing configuration for microservices.
serviceType string: The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing).
serviceWebsocketCleanupFunctionName string: Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketCleanupFunctionNamespace string: Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketCleanupFunctionQualifier string: Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionName string: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionNamespace string: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionQualifier string: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionName string: Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionNamespace string: Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionQualifier string: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
tags GetApiGatewayApiAppApiResultTag[]: API binding tag information.

api_business_type str: Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API).
api_desc str: Description of the API interface.
api_id str: API interface unique ID.
api_name str: The name of the API interface.
api_type str: API type. Possible values are NORMAL (normal API) and TSF (microservice API).
auth_relation_api_id str: OAUTH The unique ID of the authorization API associated with the business API.
auth_type str: API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH.
base64_encoded_trigger_rules Sequence[GetApiGatewayApiAppApiResultBase64EncodedTriggerRule]: Header triggers rules, and the total number of rules does not exceed 10.
constant_parameters Sequence[GetApiGatewayApiAppApiResultConstantParameter]: Constant parameters.
created_time str: Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
enable_cors bool: Whether to enable cross-domain.
environments Sequence[str]: API published environment information.
internal_domain str: WEBSOCKET pushback address.
is_base64_encoded bool: Whether to enable Base64 encoding will only take effect when the backend is scf.
is_base64_trigger bool: Whether to enable Base64-encoded header triggering will only take effect when the backend is scf.
is_debug_after_charge bool: Whether to debug after purchase (parameters reserved in the cloud market).
micro_services Sequence[GetApiGatewayApiAppApiResultMicroService]: API binding microservice list.
micro_services_infos Sequence[float]: Microservice information details.
modified_time str: Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
oauth_configs Sequence[GetApiGatewayApiAppApiResultOauthConfig]: OAUTH configuration.
protocol str: The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS.
request_configs Sequence[GetApiGatewayApiAppApiResultRequestConfig]: The requested frontend configuration.
request_parameters Sequence[GetApiGatewayApiAppApiResultRequestParameter]: Front-end request parameters.
response_error_codes Sequence[GetApiGatewayApiAppApiResultResponseErrorCode]: User-defined error code configuration.
response_fail_example str: Custom response configuration failure response example.
response_success_example str: Custom response configuration successful response example.
response_type str: Return type.
service_configs Sequence[GetApiGatewayApiAppApiResultServiceConfig]: Backend service configuration for the API.
service_desc str: A description of the service where the API resides.
service_id str: The unique ID of the service where the API resides.
service_mock_return_message str: APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed.
service_name str: The name of the service where the API resides.
service_parameters Sequence[GetApiGatewayApiAppApiResultServiceParameter]: API backend service parameters.
service_scf_function_name str: Scf function name. Effective when the backend type is SCF.
service_scf_function_namespace str: Scf function namespace. Effective when the backend type is SCF.
service_scf_function_qualifier str: Scf function version. Effective when the backend type is SCF.
service_scf_is_integrated_response bool: Whether to enable integrated response.
service_timeout float: The backend service timeout of the API, in seconds.
service_tsf_health_check_confs Sequence[GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf]: Health check configuration for microservices.
service_tsf_load_balance_confs Sequence[GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf]: Load balancing configuration for microservices.
service_type str: The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing).
service_websocket_cleanup_function_name str: Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_cleanup_function_namespace str: Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_cleanup_function_qualifier str: Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_register_function_name str: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_register_function_namespace str: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_register_function_qualifier str: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_transport_function_name str: Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_transport_function_namespace str: Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
service_websocket_transport_function_qualifier str: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
tags Sequence[GetApiGatewayApiAppApiResultTag]: API binding tag information.

apiBusinessType String: Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API).
apiDesc String: Description of the API interface.
apiId String: API interface unique ID.
apiName String: The name of the API interface.
apiType String: API type. Possible values are NORMAL (normal API) and TSF (microservice API).
authRelationApiId String: OAUTH The unique ID of the authorization API associated with the business API.
authType String: API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH.
base64EncodedTriggerRules List<Property Map>: Header triggers rules, and the total number of rules does not exceed 10.
constantParameters List<Property Map>: Constant parameters.
createdTime String: Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
enableCors Boolean: Whether to enable cross-domain.
environments List<String>: API published environment information.
internalDomain String: WEBSOCKET pushback address.
isBase64Encoded Boolean: Whether to enable Base64 encoding will only take effect when the backend is scf.
isBase64Trigger Boolean: Whether to enable Base64-encoded header triggering will only take effect when the backend is scf.
isDebugAfterCharge Boolean: Whether to debug after purchase (parameters reserved in the cloud market).
microServices List<Property Map>: API binding microservice list.
microServicesInfos List<Number>: Microservice information details.
modifiedTime String: Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.
oauthConfigs List<Property Map>: OAUTH configuration.
protocol String: The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS.
requestConfigs List<Property Map>: The requested frontend configuration.
requestParameters List<Property Map>: Front-end request parameters.
responseErrorCodes List<Property Map>: User-defined error code configuration.
responseFailExample String: Custom response configuration failure response example.
responseSuccessExample String: Custom response configuration successful response example.
responseType String: Return type.
serviceConfigs List<Property Map>: Backend service configuration for the API.
serviceDesc String: A description of the service where the API resides.
serviceId String: The unique ID of the service where the API resides.
serviceMockReturnMessage String: APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed.
serviceName String: The name of the service where the API resides.
serviceParameters List<Property Map>: API backend service parameters.
serviceScfFunctionName String: Scf function name. Effective when the backend type is SCF.
serviceScfFunctionNamespace String: Scf function namespace. Effective when the backend type is SCF.
serviceScfFunctionQualifier String: Scf function version. Effective when the backend type is SCF.
serviceScfIsIntegratedResponse Boolean: Whether to enable integrated response.
serviceTimeout Number: The backend service timeout of the API, in seconds.
serviceTsfHealthCheckConfs List<Property Map>: Health check configuration for microservices.
serviceTsfLoadBalanceConfs List<Property Map>: Load balancing configuration for microservices.
serviceType String: The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing).
serviceWebsocketCleanupFunctionName String: Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketCleanupFunctionNamespace String: Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketCleanupFunctionQualifier String: Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionName String: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionNamespace String: Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketRegisterFunctionQualifier String: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionName String: Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionNamespace String: Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
serviceWebsocketTransportFunctionQualifier String: Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF.
tags List<Property Map>: API binding tag information.

GetApiGatewayApiAppApiResultBase64EncodedTriggerRule

Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Values List<string>: The value of the note.

Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Values []string: The value of the note.

name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
values List<String>: The value of the note.

name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
values string[]: The value of the note.

name str: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
values Sequence[str]: The value of the note.

name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
values List<String>: The value of the note.

GetApiGatewayApiAppApiResultConstantParameter

DefaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
Desc string: Custom response configuration error code remarks.
Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.

DefaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
Desc string: Custom response configuration error code remarks.
Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.

defaultValue String: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc String: Custom response configuration error code remarks.
name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position String: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.

defaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc string: Custom response configuration error code remarks.
name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.

default_value str: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc str: Custom response configuration error code remarks.
name str: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position str: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.

defaultValue String: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc String: Custom response configuration error code remarks.
name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position String: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.

GetApiGatewayApiAppApiResultMicroService

ClusterId string: Microservice cluster ID.
MicroServiceName string: Microservice name.
NamespaceId string: Microservice namespace ID.

ClusterId string: Microservice cluster ID.
MicroServiceName string: Microservice name.
NamespaceId string: Microservice namespace ID.

clusterId String: Microservice cluster ID.
microServiceName String: Microservice name.
namespaceId String: Microservice namespace ID.

clusterId string: Microservice cluster ID.
microServiceName string: Microservice name.
namespaceId string: Microservice namespace ID.

cluster_id str: Microservice cluster ID.
micro_service_name str: Microservice name.
namespace_id str: Microservice namespace ID.

clusterId String: Microservice cluster ID.
microServiceName String: Microservice name.
namespaceId String: Microservice namespace ID.

GetApiGatewayApiAppApiResultOauthConfig

LoginRedirectUrl string: Redirect address, used to guide users to log in.
PublicKey string: Public key, used to verify user token.
TokenLocation string: Token delivery position.

LoginRedirectUrl string: Redirect address, used to guide users to log in.
PublicKey string: Public key, used to verify user token.
TokenLocation string: Token delivery position.

loginRedirectUrl String: Redirect address, used to guide users to log in.
publicKey String: Public key, used to verify user token.
tokenLocation String: Token delivery position.

loginRedirectUrl string: Redirect address, used to guide users to log in.
publicKey string: Public key, used to verify user token.
tokenLocation string: Token delivery position.

login_redirect_url str: Redirect address, used to guide users to log in.
public_key str: Public key, used to verify user token.
token_location str: Token delivery position.

loginRedirectUrl String: Redirect address, used to guide users to log in.
publicKey String: Public key, used to verify user token.
tokenLocation String: Token delivery position.

GetApiGatewayApiAppApiResultRequestConfig

Method string: Load balancing method.
Path string: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.

Method string: Load balancing method.
Path string: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.

method String: Load balancing method.
path String: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.

method string: Load balancing method.
path string: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.

method str: Load balancing method.
path str: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.

method String: Load balancing method.
path String: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.

GetApiGatewayApiAppApiResultRequestParameter

DefaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
Desc string: Custom response configuration error code remarks.
Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
Required bool: .
Type string: API front-end parameter type, such as String, int.

DefaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
Desc string: Custom response configuration error code remarks.
Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
Required bool: .
Type string: API front-end parameter type, such as String, int.

defaultValue String: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc String: Custom response configuration error code remarks.
name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position String: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
required Boolean: .
type String: API front-end parameter type, such as String, int.

defaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc string: Custom response configuration error code remarks.
name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
required boolean: .
type string: API front-end parameter type, such as String, int.

default_value str: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc str: Custom response configuration error code remarks.
name str: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position str: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
required bool: .
type str: API front-end parameter type, such as String, int.

defaultValue String: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
desc String: Custom response configuration error code remarks.
name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position String: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
required Boolean: .
type String: API front-end parameter type, such as String, int.

GetApiGatewayApiAppApiResultResponseErrorCode

Code double: Custom response configuration error code.
ConvertedCode double: Custom error code conversion.
Desc string: Custom response configuration error code remarks.
Msg string: Custom response configuration error message.
NeedConvert bool: Whether it is necessary to enable error code conversion.

Code float64: Custom response configuration error code.
ConvertedCode float64: Custom error code conversion.
Desc string: Custom response configuration error code remarks.
Msg string: Custom response configuration error message.
NeedConvert bool: Whether it is necessary to enable error code conversion.

code Double: Custom response configuration error code.
convertedCode Double: Custom error code conversion.
desc String: Custom response configuration error code remarks.
msg String: Custom response configuration error message.
needConvert Boolean: Whether it is necessary to enable error code conversion.

code number: Custom response configuration error code.
convertedCode number: Custom error code conversion.
desc string: Custom response configuration error code remarks.
msg string: Custom response configuration error message.
needConvert boolean: Whether it is necessary to enable error code conversion.

code float: Custom response configuration error code.
converted_code float: Custom error code conversion.
desc str: Custom response configuration error code remarks.
msg str: Custom response configuration error message.
need_convert bool: Whether it is necessary to enable error code conversion.

code Number: Custom response configuration error code.
convertedCode Number: Custom error code conversion.
desc String: Custom response configuration error code remarks.
msg String: Custom response configuration error message.
needConvert Boolean: Whether it is necessary to enable error code conversion.

GetApiGatewayApiAppApiResultServiceConfig

Method string: Load balancing method.
Path string: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.
Product string: Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream.
UniqVpcId string: The unique ID of the vpc.
UpstreamId string: Only required when binding vpc channel.
Url string: API's backend service url. If ServiceType is HTTP, this parameter must be passed.

Method string: Load balancing method.
Path string: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.
Product string: Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream.
UniqVpcId string: The unique ID of the vpc.
UpstreamId string: Only required when binding vpc channel.
Url string: API's backend service url. If ServiceType is HTTP, this parameter must be passed.

method String: Load balancing method.
path String: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.
product String: Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream.
uniqVpcId String: The unique ID of the vpc.
upstreamId String: Only required when binding vpc channel.
url String: API's backend service url. If ServiceType is HTTP, this parameter must be passed.

method string: Load balancing method.
path string: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.
product string: Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream.
uniqVpcId string: The unique ID of the vpc.
upstreamId string: Only required when binding vpc channel.
url string: API's backend service url. If ServiceType is HTTP, this parameter must be passed.

method str: Load balancing method.
path str: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.
product str: Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream.
uniq_vpc_id str: The unique ID of the vpc.
upstream_id str: Only required when binding vpc channel.
url str: API's backend service url. If ServiceType is HTTP, this parameter must be passed.

method String: Load balancing method.
path String: API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different.
product String: Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream.
uniqVpcId String: The unique ID of the vpc.
upstreamId String: Only required when binding vpc channel.
url String: API's backend service url. If ServiceType is HTTP, this parameter must be passed.

GetApiGatewayApiAppApiResultServiceParameter

DefaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
RelevantRequestParameterDesc string: Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP.
RelevantRequestParameterName string: The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP.
RelevantRequestParameterPosition string: The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP.

DefaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
Name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
Position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
RelevantRequestParameterDesc string: Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP.
RelevantRequestParameterName string: The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP.
RelevantRequestParameterPosition string: The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP.

defaultValue String: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position String: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
relevantRequestParameterDesc String: Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP.
relevantRequestParameterName String: The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP.
relevantRequestParameterPosition String: The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP.

defaultValue string: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
name string: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position string: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
relevantRequestParameterDesc string: Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP.
relevantRequestParameterName string: The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP.
relevantRequestParameterPosition string: The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP.

default_value str: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
name str: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position str: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
relevant_request_parameter_desc str: Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP.
relevant_request_parameter_name str: The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP.
relevant_request_parameter_position str: The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP.

defaultValue String: Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP.
name String: The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different.
position String: The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently.
relevantRequestParameterDesc String: Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP.
relevantRequestParameterName String: The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP.
relevantRequestParameterPosition String: The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP.

GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf

ErrorThresholdPercentage double: Threshold percentage.
IsHealthCheck bool: Whether to enable health check.
RequestVolumeThreshold double: Health check threshold.
SleepWindowInMilliseconds double: Window size.

ErrorThresholdPercentage float64: Threshold percentage.
IsHealthCheck bool: Whether to enable health check.
RequestVolumeThreshold float64: Health check threshold.
SleepWindowInMilliseconds float64: Window size.

errorThresholdPercentage Double: Threshold percentage.
isHealthCheck Boolean: Whether to enable health check.
requestVolumeThreshold Double: Health check threshold.
sleepWindowInMilliseconds Double: Window size.

errorThresholdPercentage number: Threshold percentage.
isHealthCheck boolean: Whether to enable health check.
requestVolumeThreshold number: Health check threshold.
sleepWindowInMilliseconds number: Window size.

error_threshold_percentage float: Threshold percentage.
is_health_check bool: Whether to enable health check.
request_volume_threshold float: Health check threshold.
sleep_window_in_milliseconds float: Window size.

errorThresholdPercentage Number: Threshold percentage.
isHealthCheck Boolean: Whether to enable health check.
requestVolumeThreshold Number: Health check threshold.
sleepWindowInMilliseconds Number: Window size.

GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf

IsLoadBalance bool: Whether to enable load balancing.
Method string: Load balancing method.
SessionStickRequired bool: Whether to enable session persistence.
SessionStickTimeout double: Session retention timeout.

IsLoadBalance bool: Whether to enable load balancing.
Method string: Load balancing method.
SessionStickRequired bool: Whether to enable session persistence.
SessionStickTimeout float64: Session retention timeout.

isLoadBalance Boolean: Whether to enable load balancing.
method String: Load balancing method.
sessionStickRequired Boolean: Whether to enable session persistence.
sessionStickTimeout Double: Session retention timeout.

isLoadBalance boolean: Whether to enable load balancing.
method string: Load balancing method.
sessionStickRequired boolean: Whether to enable session persistence.
sessionStickTimeout number: Session retention timeout.

is_load_balance bool: Whether to enable load balancing.
method str: Load balancing method.
session_stick_required bool: Whether to enable session persistence.
session_stick_timeout float: Session retention timeout.

isLoadBalance Boolean: Whether to enable load balancing.
method String: Load balancing method.
sessionStickRequired Boolean: Whether to enable session persistence.
sessionStickTimeout Number: Session retention timeout.

GetApiGatewayApiAppApiResultTag

Key string: Key of the label.
Value string: The value of the note.

Key string: Key of the label.
Value string: The value of the note.

key String: Key of the label.
value String: The value of the note.

key string: Key of the label.
value string: The value of the note.

key str: Key of the label.
value str: The value of the note.

key String: Key of the label.
value String: The value of the note.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getApiGatewayApiAppApi

On this page

On this page

Example Usage

Using getApiGatewayApiAppApi

getApiGatewayApiAppApi Result

Supporting Types

GetApiGatewayApiAppApiResult

GetApiGatewayApiAppApiResultBase64EncodedTriggerRule

GetApiGatewayApiAppApiResultConstantParameter

GetApiGatewayApiAppApiResultMicroService

GetApiGatewayApiAppApiResultOauthConfig

GetApiGatewayApiAppApiResultRequestConfig

GetApiGatewayApiAppApiResultRequestParameter

GetApiGatewayApiAppApiResultResponseErrorCode

GetApiGatewayApiAppApiResultServiceConfig

GetApiGatewayApiAppApiResultServiceParameter

GetApiGatewayApiAppApiResultServiceTsfHealthCheckConf

GetApiGatewayApiAppApiResultServiceTsfLoadBalanceConf

GetApiGatewayApiAppApiResultTag

Package Details

On this page

On this page