Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ApiGatewayApi
tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ApiGatewayApi

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this resource to create API of API gateway.

    Example Usage

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

const example = new tencentcloud.ApiGatewayService("example", {
    serviceName: "tf-example",
    protocol: "http&https",
    netTypes: [
        "INNER",
        "OUTER",
    ],
    ipVersion: "IPv4",
});
const api = new tencentcloud.ApiGatewayApi("api", {
    serviceId: example.apiGatewayServiceId,
    apiName: "tf-example",
    apiDesc: "desc.",
    authType: "NONE",
    protocol: "HTTP",
    enableCors: true,
    requestConfigPath: "/user/info",
    requestConfigMethod: "GET",
    requestParameters: [{
        name: "name",
        position: "QUERY",
        type: "string",
        desc: "who are you?",
        defaultValue: "tom",
        required: true,
    }],
    serviceConfigType: "HTTP",
    serviceConfigTimeout: 15,
    serviceConfigUrl: "http://www.qq.com",
    serviceConfigPath: "/user",
    serviceConfigMethod: "GET",
    responseType: "HTML",
    responseSuccessExample: "success",
    responseFailExample: "fail",
    responseErrorCodes: [{
        code: 500,
        msg: "system error",
        desc: "system error code",
        convertedCode: 5000,
        needConvert: true,
    }],
    releaseLimit: 500,
    preLimit: 500,
    testLimit: 500,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ApiGatewayService("example",
    service_name="tf-example",
    protocol="http&https",
    net_types=[
        "INNER",
        "OUTER",
    ],
    ip_version="IPv4")
api = tencentcloud.ApiGatewayApi("api",
    service_id=example.api_gateway_service_id,
    api_name="tf-example",
    api_desc="desc.",
    auth_type="NONE",
    protocol="HTTP",
    enable_cors=True,
    request_config_path="/user/info",
    request_config_method="GET",
    request_parameters=[{
        "name": "name",
        "position": "QUERY",
        "type": "string",
        "desc": "who are you?",
        "default_value": "tom",
        "required": True,
    }],
    service_config_type="HTTP",
    service_config_timeout=15,
    service_config_url="http://www.qq.com",
    service_config_path="/user",
    service_config_method="GET",
    response_type="HTML",
    response_success_example="success",
    response_fail_example="fail",
    response_error_codes=[{
        "code": 500,
        "msg": "system error",
        "desc": "system error code",
        "converted_code": 5000,
        "need_convert": True,
    }],
    release_limit=500,
    pre_limit=500,
    test_limit=500)

    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 {
		example, err := tencentcloud.NewApiGatewayService(ctx, "example", &tencentcloud.ApiGatewayServiceArgs{
			ServiceName: pulumi.String("tf-example"),
			Protocol:    pulumi.String("http&https"),
			NetTypes: pulumi.StringArray{
				pulumi.String("INNER"),
				pulumi.String("OUTER"),
			},
			IpVersion: pulumi.String("IPv4"),
		})
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewApiGatewayApi(ctx, "api", &tencentcloud.ApiGatewayApiArgs{
			ServiceId:           example.ApiGatewayServiceId,
			ApiName:             pulumi.String("tf-example"),
			ApiDesc:             pulumi.String("desc."),
			AuthType:            pulumi.String("NONE"),
			Protocol:            pulumi.String("HTTP"),
			EnableCors:          pulumi.Bool(true),
			RequestConfigPath:   pulumi.String("/user/info"),
			RequestConfigMethod: pulumi.String("GET"),
			RequestParameters: tencentcloud.ApiGatewayApiRequestParameterArray{
				&tencentcloud.ApiGatewayApiRequestParameterArgs{
					Name:         pulumi.String("name"),
					Position:     pulumi.String("QUERY"),
					Type:         pulumi.String("string"),
					Desc:         pulumi.String("who are you?"),
					DefaultValue: pulumi.String("tom"),
					Required:     pulumi.Bool(true),
				},
			},
			ServiceConfigType:      pulumi.String("HTTP"),
			ServiceConfigTimeout:   pulumi.Float64(15),
			ServiceConfigUrl:       pulumi.String("http://www.qq.com"),
			ServiceConfigPath:      pulumi.String("/user"),
			ServiceConfigMethod:    pulumi.String("GET"),
			ResponseType:           pulumi.String("HTML"),
			ResponseSuccessExample: pulumi.String("success"),
			ResponseFailExample:    pulumi.String("fail"),
			ResponseErrorCodes: tencentcloud.ApiGatewayApiResponseErrorCodeArray{
				&tencentcloud.ApiGatewayApiResponseErrorCodeArgs{
					Code:          pulumi.Float64(500),
					Msg:           pulumi.String("system error"),
					Desc:          pulumi.String("system error code"),
					ConvertedCode: pulumi.Float64(5000),
					NeedConvert:   pulumi.Bool(true),
				},
			},
			ReleaseLimit: pulumi.Float64(500),
			PreLimit:     pulumi.Float64(500),
			TestLimit:    pulumi.Float64(500),
		})
		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 = new Tencentcloud.ApiGatewayService("example", new()
    {
        ServiceName = "tf-example",
        Protocol = "http&https",
        NetTypes = new[]
        {
            "INNER",
            "OUTER",
        },
        IpVersion = "IPv4",
    });

    var api = new Tencentcloud.ApiGatewayApi("api", new()
    {
        ServiceId = example.ApiGatewayServiceId,
        ApiName = "tf-example",
        ApiDesc = "desc.",
        AuthType = "NONE",
        Protocol = "HTTP",
        EnableCors = true,
        RequestConfigPath = "/user/info",
        RequestConfigMethod = "GET",
        RequestParameters = new[]
        {
            new Tencentcloud.Inputs.ApiGatewayApiRequestParameterArgs
            {
                Name = "name",
                Position = "QUERY",
                Type = "string",
                Desc = "who are you?",
                DefaultValue = "tom",
                Required = true,
            },
        },
        ServiceConfigType = "HTTP",
        ServiceConfigTimeout = 15,
        ServiceConfigUrl = "http://www.qq.com",
        ServiceConfigPath = "/user",
        ServiceConfigMethod = "GET",
        ResponseType = "HTML",
        ResponseSuccessExample = "success",
        ResponseFailExample = "fail",
        ResponseErrorCodes = new[]
        {
            new Tencentcloud.Inputs.ApiGatewayApiResponseErrorCodeArgs
            {
                Code = 500,
                Msg = "system error",
                Desc = "system error code",
                ConvertedCode = 5000,
                NeedConvert = true,
            },
        },
        ReleaseLimit = 500,
        PreLimit = 500,
        TestLimit = 500,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayService;
import com.pulumi.tencentcloud.ApiGatewayServiceArgs;
import com.pulumi.tencentcloud.ApiGatewayApi;
import com.pulumi.tencentcloud.ApiGatewayApiArgs;
import com.pulumi.tencentcloud.inputs.ApiGatewayApiRequestParameterArgs;
import com.pulumi.tencentcloud.inputs.ApiGatewayApiResponseErrorCodeArgs;
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) {
        var example = new ApiGatewayService("example", ApiGatewayServiceArgs.builder()
            .serviceName("tf-example")
            .protocol("http&https")
            .netTypes(            
                "INNER",
                "OUTER")
            .ipVersion("IPv4")
            .build());

        var api = new ApiGatewayApi("api", ApiGatewayApiArgs.builder()
            .serviceId(example.apiGatewayServiceId())
            .apiName("tf-example")
            .apiDesc("desc.")
            .authType("NONE")
            .protocol("HTTP")
            .enableCors(true)
            .requestConfigPath("/user/info")
            .requestConfigMethod("GET")
            .requestParameters(ApiGatewayApiRequestParameterArgs.builder()
                .name("name")
                .position("QUERY")
                .type("string")
                .desc("who are you?")
                .defaultValue("tom")
                .required(true)
                .build())
            .serviceConfigType("HTTP")
            .serviceConfigTimeout(15)
            .serviceConfigUrl("http://www.qq.com")
            .serviceConfigPath("/user")
            .serviceConfigMethod("GET")
            .responseType("HTML")
            .responseSuccessExample("success")
            .responseFailExample("fail")
            .responseErrorCodes(ApiGatewayApiResponseErrorCodeArgs.builder()
                .code(500)
                .msg("system error")
                .desc("system error code")
                .convertedCode(5000)
                .needConvert(true)
                .build())
            .releaseLimit(500)
            .preLimit(500)
            .testLimit(500)
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ApiGatewayService
    properties:
      serviceName: tf-example
      protocol: http&https
      netTypes:
        - INNER
        - OUTER
      ipVersion: IPv4
  api:
    type: tencentcloud:ApiGatewayApi
    properties:
      serviceId: ${example.apiGatewayServiceId}
      apiName: tf-example
      apiDesc: desc.
      authType: NONE
      protocol: HTTP
      enableCors: true
      requestConfigPath: /user/info
      requestConfigMethod: GET
      requestParameters:
        - name: name
          position: QUERY
          type: string
          desc: who are you?
          defaultValue: tom
          required: true
      serviceConfigType: HTTP
      serviceConfigTimeout: 15
      serviceConfigUrl: http://www.qq.com
      serviceConfigPath: /user
      serviceConfigMethod: GET
      responseType: HTML
      responseSuccessExample: success
      responseFailExample: fail
      responseErrorCodes:
        - code: 500
          msg: system error
          desc: system error code
          convertedCode: 5000
          needConvert: true
      releaseLimit: 500
      preLimit: 500
      testLimit: 500

    Create ApiGatewayApi Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiGatewayApi(name: string, args: ApiGatewayApiArgs, opts?: CustomResourceOptions);
    @overload
def ApiGatewayApi(resource_name: str,
                  args: ApiGatewayApiArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ApiGatewayApi(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  api_name: Optional[str] = None,
                  request_config_path: Optional[str] = None,
                  service_id: Optional[str] = None,
                  api_business_type: Optional[str] = None,
                  api_desc: Optional[str] = None,
                  api_gateway_api_id: Optional[str] = None,
                  api_type: Optional[str] = None,
                  auth_relation_api_id: Optional[str] = None,
                  auth_type: Optional[str] = None,
                  constant_parameters: Optional[Sequence[ApiGatewayApiConstantParameterArgs]] = None,
                  eiam_app_id: Optional[str] = None,
                  eiam_app_type: Optional[str] = None,
                  eiam_auth_type: Optional[str] = None,
                  enable_cors: Optional[bool] = None,
                  event_bus_id: Optional[str] = None,
                  is_base64_encoded: Optional[bool] = None,
                  is_debug_after_charge: Optional[bool] = None,
                  is_delete_response_error_codes: Optional[bool] = None,
                  micro_services: Optional[Sequence[ApiGatewayApiMicroServiceArgs]] = None,
                  oauth_config: Optional[ApiGatewayApiOauthConfigArgs] = None,
                  owner: Optional[str] = None,
                  pre_limit: Optional[float] = None,
                  protocol: Optional[str] = None,
                  release_limit: Optional[float] = None,
                  request_config_method: Optional[str] = None,
                  request_parameters: Optional[Sequence[ApiGatewayApiRequestParameterArgs]] = None,
                  response_error_codes: Optional[Sequence[ApiGatewayApiResponseErrorCodeArgs]] = None,
                  response_fail_example: Optional[str] = None,
                  response_success_example: Optional[str] = None,
                  response_type: Optional[str] = None,
                  service_config_cos_config: Optional[ApiGatewayApiServiceConfigCosConfigArgs] = None,
                  service_config_method: Optional[str] = None,
                  service_config_mock_return_message: Optional[str] = None,
                  service_config_path: Optional[str] = None,
                  service_config_product: Optional[str] = None,
                  service_config_scf_function_name: Optional[str] = None,
                  service_config_scf_function_namespace: Optional[str] = None,
                  service_config_scf_function_qualifier: Optional[str] = None,
                  service_config_scf_function_type: Optional[str] = None,
                  service_config_scf_is_integrated_response: Optional[bool] = None,
                  service_config_timeout: Optional[float] = None,
                  service_config_type: Optional[str] = None,
                  service_config_upstream_id: Optional[str] = None,
                  service_config_url: Optional[str] = None,
                  service_config_vpc_id: Optional[str] = None,
                  service_config_websocket_cleanup_function_name: Optional[str] = None,
                  service_config_websocket_cleanup_function_namespace: Optional[str] = None,
                  service_config_websocket_cleanup_function_qualifier: Optional[str] = None,
                  service_config_websocket_register_function_name: Optional[str] = None,
                  service_config_websocket_register_function_namespace: Optional[str] = None,
                  service_config_websocket_register_function_qualifier: Optional[str] = None,
                  service_config_websocket_transport_function_name: Optional[str] = None,
                  service_config_websocket_transport_function_namespace: Optional[str] = None,
                  service_config_websocket_transport_function_qualifier: Optional[str] = None,
                  service_parameters: Optional[Sequence[ApiGatewayApiServiceParameterArgs]] = None,
                  service_tsf_health_check_conf: Optional[ApiGatewayApiServiceTsfHealthCheckConfArgs] = None,
                  service_tsf_load_balance_conf: Optional[ApiGatewayApiServiceTsfLoadBalanceConfArgs] = None,
                  target_namespace_id: Optional[str] = None,
                  target_services: Optional[Sequence[ApiGatewayApiTargetServiceArgs]] = None,
                  target_services_health_check_conf: Optional[ApiGatewayApiTargetServicesHealthCheckConfArgs] = None,
                  target_services_load_balance_conf: Optional[float] = None,
                  test_limit: Optional[float] = None,
                  token_timeout: Optional[float] = None,
                  user_type: Optional[str] = None)
    func NewApiGatewayApi(ctx *Context, name string, args ApiGatewayApiArgs, opts ...ResourceOption) (*ApiGatewayApi, error)
    public ApiGatewayApi(string name, ApiGatewayApiArgs args, CustomResourceOptions? opts = null)
    public ApiGatewayApi(String name, ApiGatewayApiArgs args)
public ApiGatewayApi(String name, ApiGatewayApiArgs args, CustomResourceOptions options)

    type: tencentcloud:ApiGatewayApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiGatewayApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiGatewayApiArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiGatewayApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ApiGatewayApi Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiGatewayApi resource accepts the following input properties:

    ApiName string
    Custom API name.
    RequestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    ServiceId string
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiGatewayApiId string
    ID of the resource.
    ApiType string
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    AuthRelationApiId string
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    AuthType string
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    ConstantParameters List<ApiGatewayApiConstantParameter>
    Constant parameter.
    EiamAppId string
    EIAM application ID.
    EiamAppType string
    EIAM application type.
    EiamAuthType string
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    EnableCors bool
    Whether to enable CORS. Default value: true.
    EventBusId string
    Event bus ID.
    IsBase64Encoded bool
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    IsDebugAfterCharge bool
    Charge after starting debugging. (Cloud Market Reserved Fields).
    IsDeleteResponseErrorCodes bool
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    MicroServices List<ApiGatewayApiMicroService>
    API bound microservice list.
    OauthConfig ApiGatewayApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    Owner string
    Owner of resources.
    PreLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    ReleaseLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    RequestConfigMethod string
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    RequestParameters List<ApiGatewayApiRequestParameter>
    Frontend request parameters.
    ResponseErrorCodes List<ApiGatewayApiResponseErrorCode>
    Custom error code configuration. Must keep at least one after set.
    ResponseFailExample string
    Response failure sample of custom response configuration.
    ResponseSuccessExample string
    Successful response sample of custom response configuration.
    ResponseType string
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    ServiceConfigCosConfig ApiGatewayApiServiceConfigCosConfig
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigMethod string
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    ServiceConfigMockReturnMessage string
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    ServiceConfigPath string
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    ServiceConfigProduct string
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    ServiceConfigScfFunctionName string
    SCF function name. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionNamespace string
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionQualifier string
    SCF function version. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionType string
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    ServiceConfigScfIsIntegratedResponse bool
    Whether to enable response integration. Effective when the backend type is SCF.
    ServiceConfigTimeout double
    API backend service timeout period in seconds. Default value: 5.
    ServiceConfigType string
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    ServiceConfigUpstreamId string
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigUrl string
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    ServiceConfigVpcId string
    Unique VPC ID.
    ServiceConfigWebsocketCleanupFunctionName string
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionNamespace string
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionQualifier string
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionName string
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionNamespace string
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionName string
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionNamespace string
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceParameters List<ApiGatewayApiServiceParameter>
    The backend service parameters of the API.
    ServiceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    TargetNamespaceId string
    Tsf serverless namespace ID. (In internal testing).
    TargetServices List<ApiGatewayApiTargetService>
    Target type backend resource information. (Internal testing stage).
    TargetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConf
    Target health check configuration. (Internal testing stage).
    TargetServicesLoadBalanceConf double
    Target type load balancing configuration. (Internal testing stage).
    TestLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    TokenTimeout double
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    UserType string
    User type.
    ApiName string
    Custom API name.
    RequestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    ServiceId string
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiGatewayApiId string
    ID of the resource.
    ApiType string
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    AuthRelationApiId string
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    AuthType string
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    ConstantParameters []ApiGatewayApiConstantParameterArgs
    Constant parameter.
    EiamAppId string
    EIAM application ID.
    EiamAppType string
    EIAM application type.
    EiamAuthType string
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    EnableCors bool
    Whether to enable CORS. Default value: true.
    EventBusId string
    Event bus ID.
    IsBase64Encoded bool
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    IsDebugAfterCharge bool
    Charge after starting debugging. (Cloud Market Reserved Fields).
    IsDeleteResponseErrorCodes bool
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    MicroServices []ApiGatewayApiMicroServiceArgs
    API bound microservice list.
    OauthConfig ApiGatewayApiOauthConfigArgs
    OAuth configuration. Effective when AuthType is OAUTH.
    Owner string
    Owner of resources.
    PreLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    ReleaseLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    RequestConfigMethod string
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    RequestParameters []ApiGatewayApiRequestParameterArgs
    Frontend request parameters.
    ResponseErrorCodes []ApiGatewayApiResponseErrorCodeArgs
    Custom error code configuration. Must keep at least one after set.
    ResponseFailExample string
    Response failure sample of custom response configuration.
    ResponseSuccessExample string
    Successful response sample of custom response configuration.
    ResponseType string
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    ServiceConfigCosConfig ApiGatewayApiServiceConfigCosConfigArgs
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigMethod string
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    ServiceConfigMockReturnMessage string
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    ServiceConfigPath string
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    ServiceConfigProduct string
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    ServiceConfigScfFunctionName string
    SCF function name. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionNamespace string
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionQualifier string
    SCF function version. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionType string
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    ServiceConfigScfIsIntegratedResponse bool
    Whether to enable response integration. Effective when the backend type is SCF.
    ServiceConfigTimeout float64
    API backend service timeout period in seconds. Default value: 5.
    ServiceConfigType string
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    ServiceConfigUpstreamId string
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigUrl string
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    ServiceConfigVpcId string
    Unique VPC ID.
    ServiceConfigWebsocketCleanupFunctionName string
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionNamespace string
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionQualifier string
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionName string
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionNamespace string
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionName string
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionNamespace string
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceParameters []ApiGatewayApiServiceParameterArgs
    The backend service parameters of the API.
    ServiceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConfArgs
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConfArgs
    Load balancing configuration for microservices.
    TargetNamespaceId string
    Tsf serverless namespace ID. (In internal testing).
    TargetServices []ApiGatewayApiTargetServiceArgs
    Target type backend resource information. (Internal testing stage).
    TargetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConfArgs
    Target health check configuration. (Internal testing stage).
    TargetServicesLoadBalanceConf float64
    Target type load balancing configuration. (Internal testing stage).
    TestLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    TokenTimeout float64
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    UserType string
    User type.
    apiName String
    Custom API name.
    requestConfigPath String
    Request frontend path configuration. Like /user/getinfo.
    serviceId String
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiGatewayApiId String
    ID of the resource.
    apiType String
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    authRelationApiId String
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    authType String
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constantParameters List<ApiGatewayApiConstantParameter>
    Constant parameter.
    eiamAppId String
    EIAM application ID.
    eiamAppType String
    EIAM application type.
    eiamAuthType String
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enableCors Boolean
    Whether to enable CORS. Default value: true.
    eventBusId String
    Event bus ID.
    isBase64Encoded Boolean
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    isDebugAfterCharge Boolean
    Charge after starting debugging. (Cloud Market Reserved Fields).
    isDeleteResponseErrorCodes Boolean
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    microServices List<ApiGatewayApiMicroService>
    API bound microservice list.
    oauthConfig ApiGatewayApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    owner String
    Owner of resources.
    preLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    releaseLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    requestConfigMethod String
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    requestParameters List<ApiGatewayApiRequestParameter>
    Frontend request parameters.
    responseErrorCodes List<ApiGatewayApiResponseErrorCode>
    Custom error code configuration. Must keep at least one after set.
    responseFailExample String
    Response failure sample of custom response configuration.
    responseSuccessExample String
    Successful response sample of custom response configuration.
    responseType String
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    serviceConfigCosConfig ApiGatewayApiServiceConfigCosConfig
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigMethod String
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    serviceConfigMockReturnMessage String
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    serviceConfigPath String
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    serviceConfigProduct String
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    serviceConfigScfFunctionName String
    SCF function name. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionNamespace String
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionQualifier String
    SCF function version. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionType String
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    serviceConfigScfIsIntegratedResponse Boolean
    Whether to enable response integration. Effective when the backend type is SCF.
    serviceConfigTimeout Double
    API backend service timeout period in seconds. Default value: 5.
    serviceConfigType String
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    serviceConfigUpstreamId String
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigUrl String
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    serviceConfigVpcId String
    Unique VPC ID.
    serviceConfigWebsocketCleanupFunctionName String
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionNamespace String
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionQualifier String
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionName String
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionNamespace String
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionName String
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionNamespace String
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceParameters List<ApiGatewayApiServiceParameter>
    The backend service parameters of the API.
    serviceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    serviceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    targetNamespaceId String
    Tsf serverless namespace ID. (In internal testing).
    targetServices List<ApiGatewayApiTargetService>
    Target type backend resource information. (Internal testing stage).
    targetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConf
    Target health check configuration. (Internal testing stage).
    targetServicesLoadBalanceConf Double
    Target type load balancing configuration. (Internal testing stage).
    testLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    tokenTimeout Double
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    userType String
    User type.
    apiName string
    Custom API name.
    requestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    serviceId string
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    apiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc string
    Custom API description.
    apiGatewayApiId string
    ID of the resource.
    apiType string
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    authRelationApiId string
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    authType string
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constantParameters ApiGatewayApiConstantParameter[]
    Constant parameter.
    eiamAppId string
    EIAM application ID.
    eiamAppType string
    EIAM application type.
    eiamAuthType string
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enableCors boolean
    Whether to enable CORS. Default value: true.
    eventBusId string
    Event bus ID.
    isBase64Encoded boolean
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    isDebugAfterCharge boolean
    Charge after starting debugging. (Cloud Market Reserved Fields).
    isDeleteResponseErrorCodes boolean
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    microServices ApiGatewayApiMicroService[]
    API bound microservice list.
    oauthConfig ApiGatewayApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    owner string
    Owner of resources.
    preLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    releaseLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    requestConfigMethod string
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    requestParameters ApiGatewayApiRequestParameter[]
    Frontend request parameters.
    responseErrorCodes ApiGatewayApiResponseErrorCode[]
    Custom error code configuration. Must keep at least one after set.
    responseFailExample string
    Response failure sample of custom response configuration.
    responseSuccessExample string
    Successful response sample of custom response configuration.
    responseType string
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    serviceConfigCosConfig ApiGatewayApiServiceConfigCosConfig
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigMethod string
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    serviceConfigMockReturnMessage string
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    serviceConfigPath string
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    serviceConfigProduct string
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    serviceConfigScfFunctionName string
    SCF function name. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionNamespace string
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionQualifier string
    SCF function version. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionType string
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    serviceConfigScfIsIntegratedResponse boolean
    Whether to enable response integration. Effective when the backend type is SCF.
    serviceConfigTimeout number
    API backend service timeout period in seconds. Default value: 5.
    serviceConfigType string
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    serviceConfigUpstreamId string
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigUrl string
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    serviceConfigVpcId string
    Unique VPC ID.
    serviceConfigWebsocketCleanupFunctionName string
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionNamespace string
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionQualifier string
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionName string
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionNamespace string
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionName string
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionNamespace string
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceParameters ApiGatewayApiServiceParameter[]
    The backend service parameters of the API.
    serviceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    serviceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    targetNamespaceId string
    Tsf serverless namespace ID. (In internal testing).
    targetServices ApiGatewayApiTargetService[]
    Target type backend resource information. (Internal testing stage).
    targetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConf
    Target health check configuration. (Internal testing stage).
    targetServicesLoadBalanceConf number
    Target type load balancing configuration. (Internal testing stage).
    testLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    tokenTimeout number
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    userType string
    User type.
    api_name str
    Custom API name.
    request_config_path str
    Request frontend path configuration. Like /user/getinfo.
    service_id str
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    api_business_type str
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    api_desc str
    Custom API description.
    api_gateway_api_id str
    ID of the resource.
    api_type str
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    auth_relation_api_id str
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    auth_type str
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constant_parameters Sequence[ApiGatewayApiConstantParameterArgs]
    Constant parameter.
    eiam_app_id str
    EIAM application ID.
    eiam_app_type str
    EIAM application type.
    eiam_auth_type str
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enable_cors bool
    Whether to enable CORS. Default value: true.
    event_bus_id str
    Event bus ID.
    is_base64_encoded bool
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    is_debug_after_charge bool
    Charge after starting debugging. (Cloud Market Reserved Fields).
    is_delete_response_error_codes bool
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    micro_services Sequence[ApiGatewayApiMicroServiceArgs]
    API bound microservice list.
    oauth_config ApiGatewayApiOauthConfigArgs
    OAuth configuration. Effective when AuthType is OAUTH.
    owner str
    Owner of resources.
    pre_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol str
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    release_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    request_config_method str
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    request_parameters Sequence[ApiGatewayApiRequestParameterArgs]
    Frontend request parameters.
    response_error_codes Sequence[ApiGatewayApiResponseErrorCodeArgs]
    Custom error code configuration. Must keep at least one after set.
    response_fail_example str
    Response failure sample of custom response configuration.
    response_success_example str
    Successful response sample of custom response configuration.
    response_type str
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    service_config_cos_config ApiGatewayApiServiceConfigCosConfigArgs
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    service_config_method str
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    service_config_mock_return_message str
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    service_config_path str
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    service_config_product str
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    service_config_scf_function_name str
    SCF function name. This parameter takes effect when service_config_type is SCF.
    service_config_scf_function_namespace str
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    service_config_scf_function_qualifier str
    SCF function version. This parameter takes effect when service_config_type is SCF.
    service_config_scf_function_type str
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    service_config_scf_is_integrated_response bool
    Whether to enable response integration. Effective when the backend type is SCF.
    service_config_timeout float
    API backend service timeout period in seconds. Default value: 5.
    service_config_type str
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    service_config_upstream_id str
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    service_config_url str
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    service_config_vpc_id str
    Unique VPC ID.
    service_config_websocket_cleanup_function_name str
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_cleanup_function_namespace str
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_cleanup_function_qualifier str
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_register_function_name str
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_register_function_namespace str
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_register_function_qualifier str
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_transport_function_name str
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_transport_function_namespace str
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_transport_function_qualifier str
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_parameters Sequence[ApiGatewayApiServiceParameterArgs]
    The backend service parameters of the API.
    service_tsf_health_check_conf ApiGatewayApiServiceTsfHealthCheckConfArgs
    Health check configuration for microservices.
    service_tsf_load_balance_conf ApiGatewayApiServiceTsfLoadBalanceConfArgs
    Load balancing configuration for microservices.
    target_namespace_id str
    Tsf serverless namespace ID. (In internal testing).
    target_services Sequence[ApiGatewayApiTargetServiceArgs]
    Target type backend resource information. (Internal testing stage).
    target_services_health_check_conf ApiGatewayApiTargetServicesHealthCheckConfArgs
    Target health check configuration. (Internal testing stage).
    target_services_load_balance_conf float
    Target type load balancing configuration. (Internal testing stage).
    test_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    token_timeout float
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    user_type str
    User type.
    apiName String
    Custom API name.
    requestConfigPath String
    Request frontend path configuration. Like /user/getinfo.
    serviceId String
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiGatewayApiId String
    ID of the resource.
    apiType String
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    authRelationApiId String
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    authType String
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constantParameters List<Property Map>
    Constant parameter.
    eiamAppId String
    EIAM application ID.
    eiamAppType String
    EIAM application type.
    eiamAuthType String
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enableCors Boolean
    Whether to enable CORS. Default value: true.
    eventBusId String
    Event bus ID.
    isBase64Encoded Boolean
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    isDebugAfterCharge Boolean
    Charge after starting debugging. (Cloud Market Reserved Fields).
    isDeleteResponseErrorCodes Boolean
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    microServices List<Property Map>
    API bound microservice list.
    oauthConfig Property Map
    OAuth configuration. Effective when AuthType is OAUTH.
    owner String
    Owner of resources.
    preLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    releaseLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    requestConfigMethod String
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    requestParameters List<Property Map>
    Frontend request parameters.
    responseErrorCodes List<Property Map>
    Custom error code configuration. Must keep at least one after set.
    responseFailExample String
    Response failure sample of custom response configuration.
    responseSuccessExample String
    Successful response sample of custom response configuration.
    responseType String
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    serviceConfigCosConfig Property Map
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigMethod String
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    serviceConfigMockReturnMessage String
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    serviceConfigPath String
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    serviceConfigProduct String
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    serviceConfigScfFunctionName String
    SCF function name. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionNamespace String
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionQualifier String
    SCF function version. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionType String
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    serviceConfigScfIsIntegratedResponse Boolean
    Whether to enable response integration. Effective when the backend type is SCF.
    serviceConfigTimeout Number
    API backend service timeout period in seconds. Default value: 5.
    serviceConfigType String
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    serviceConfigUpstreamId String
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigUrl String
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    serviceConfigVpcId String
    Unique VPC ID.
    serviceConfigWebsocketCleanupFunctionName String
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionNamespace String
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionQualifier String
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionName String
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionNamespace String
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionName String
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionNamespace String
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceParameters List<Property Map>
    The backend service parameters of the API.
    serviceTsfHealthCheckConf Property Map
    Health check configuration for microservices.
    serviceTsfLoadBalanceConf Property Map
    Load balancing configuration for microservices.
    targetNamespaceId String
    Tsf serverless namespace ID. (In internal testing).
    targetServices List<Property Map>
    Target type backend resource information. (Internal testing stage).
    targetServicesHealthCheckConf Property Map
    Target health check configuration. (Internal testing stage).
    targetServicesLoadBalanceConf Number
    Target type load balancing configuration. (Internal testing stage).
    testLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    tokenTimeout Number
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    userType String
    User type.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiGatewayApi resource produces the following output properties:

    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    createTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    create_time str
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id str
    The provider-assigned unique ID for this managed resource.
    update_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.

    Look up Existing ApiGatewayApi Resource

    Get an existing ApiGatewayApi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiGatewayApiState, opts?: CustomResourceOptions): ApiGatewayApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_business_type: Optional[str] = None,
        api_desc: Optional[str] = None,
        api_gateway_api_id: Optional[str] = None,
        api_name: Optional[str] = None,
        api_type: Optional[str] = None,
        auth_relation_api_id: Optional[str] = None,
        auth_type: Optional[str] = None,
        constant_parameters: Optional[Sequence[ApiGatewayApiConstantParameterArgs]] = None,
        create_time: Optional[str] = None,
        eiam_app_id: Optional[str] = None,
        eiam_app_type: Optional[str] = None,
        eiam_auth_type: Optional[str] = None,
        enable_cors: Optional[bool] = None,
        event_bus_id: Optional[str] = None,
        is_base64_encoded: Optional[bool] = None,
        is_debug_after_charge: Optional[bool] = None,
        is_delete_response_error_codes: Optional[bool] = None,
        micro_services: Optional[Sequence[ApiGatewayApiMicroServiceArgs]] = None,
        oauth_config: Optional[ApiGatewayApiOauthConfigArgs] = None,
        owner: Optional[str] = None,
        pre_limit: Optional[float] = None,
        protocol: Optional[str] = None,
        release_limit: Optional[float] = None,
        request_config_method: Optional[str] = None,
        request_config_path: Optional[str] = None,
        request_parameters: Optional[Sequence[ApiGatewayApiRequestParameterArgs]] = None,
        response_error_codes: Optional[Sequence[ApiGatewayApiResponseErrorCodeArgs]] = None,
        response_fail_example: Optional[str] = None,
        response_success_example: Optional[str] = None,
        response_type: Optional[str] = None,
        service_config_cos_config: Optional[ApiGatewayApiServiceConfigCosConfigArgs] = None,
        service_config_method: Optional[str] = None,
        service_config_mock_return_message: Optional[str] = None,
        service_config_path: Optional[str] = None,
        service_config_product: Optional[str] = None,
        service_config_scf_function_name: Optional[str] = None,
        service_config_scf_function_namespace: Optional[str] = None,
        service_config_scf_function_qualifier: Optional[str] = None,
        service_config_scf_function_type: Optional[str] = None,
        service_config_scf_is_integrated_response: Optional[bool] = None,
        service_config_timeout: Optional[float] = None,
        service_config_type: Optional[str] = None,
        service_config_upstream_id: Optional[str] = None,
        service_config_url: Optional[str] = None,
        service_config_vpc_id: Optional[str] = None,
        service_config_websocket_cleanup_function_name: Optional[str] = None,
        service_config_websocket_cleanup_function_namespace: Optional[str] = None,
        service_config_websocket_cleanup_function_qualifier: Optional[str] = None,
        service_config_websocket_register_function_name: Optional[str] = None,
        service_config_websocket_register_function_namespace: Optional[str] = None,
        service_config_websocket_register_function_qualifier: Optional[str] = None,
        service_config_websocket_transport_function_name: Optional[str] = None,
        service_config_websocket_transport_function_namespace: Optional[str] = None,
        service_config_websocket_transport_function_qualifier: Optional[str] = None,
        service_id: Optional[str] = None,
        service_parameters: Optional[Sequence[ApiGatewayApiServiceParameterArgs]] = None,
        service_tsf_health_check_conf: Optional[ApiGatewayApiServiceTsfHealthCheckConfArgs] = None,
        service_tsf_load_balance_conf: Optional[ApiGatewayApiServiceTsfLoadBalanceConfArgs] = None,
        target_namespace_id: Optional[str] = None,
        target_services: Optional[Sequence[ApiGatewayApiTargetServiceArgs]] = None,
        target_services_health_check_conf: Optional[ApiGatewayApiTargetServicesHealthCheckConfArgs] = None,
        target_services_load_balance_conf: Optional[float] = None,
        test_limit: Optional[float] = None,
        token_timeout: Optional[float] = None,
        update_time: Optional[str] = None,
        user_type: Optional[str] = None) -> ApiGatewayApi
    func GetApiGatewayApi(ctx *Context, name string, id IDInput, state *ApiGatewayApiState, opts ...ResourceOption) (*ApiGatewayApi, error)
    public static ApiGatewayApi Get(string name, Input<string> id, ApiGatewayApiState? state, CustomResourceOptions? opts = null)
    public static ApiGatewayApi get(String name, Output<String> id, ApiGatewayApiState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ApiGatewayApi    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiGatewayApiId string
    ID of the resource.
    ApiName string
    Custom API name.
    ApiType string
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    AuthRelationApiId string
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    AuthType string
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    ConstantParameters List<ApiGatewayApiConstantParameter>
    Constant parameter.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    EiamAppId string
    EIAM application ID.
    EiamAppType string
    EIAM application type.
    EiamAuthType string
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    EnableCors bool
    Whether to enable CORS. Default value: true.
    EventBusId string
    Event bus ID.
    IsBase64Encoded bool
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    IsDebugAfterCharge bool
    Charge after starting debugging. (Cloud Market Reserved Fields).
    IsDeleteResponseErrorCodes bool
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    MicroServices List<ApiGatewayApiMicroService>
    API bound microservice list.
    OauthConfig ApiGatewayApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    Owner string
    Owner of resources.
    PreLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    ReleaseLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    RequestConfigMethod string
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    RequestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    RequestParameters List<ApiGatewayApiRequestParameter>
    Frontend request parameters.
    ResponseErrorCodes List<ApiGatewayApiResponseErrorCode>
    Custom error code configuration. Must keep at least one after set.
    ResponseFailExample string
    Response failure sample of custom response configuration.
    ResponseSuccessExample string
    Successful response sample of custom response configuration.
    ResponseType string
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    ServiceConfigCosConfig ApiGatewayApiServiceConfigCosConfig
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigMethod string
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    ServiceConfigMockReturnMessage string
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    ServiceConfigPath string
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    ServiceConfigProduct string
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    ServiceConfigScfFunctionName string
    SCF function name. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionNamespace string
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionQualifier string
    SCF function version. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionType string
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    ServiceConfigScfIsIntegratedResponse bool
    Whether to enable response integration. Effective when the backend type is SCF.
    ServiceConfigTimeout double
    API backend service timeout period in seconds. Default value: 5.
    ServiceConfigType string
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    ServiceConfigUpstreamId string
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigUrl string
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    ServiceConfigVpcId string
    Unique VPC ID.
    ServiceConfigWebsocketCleanupFunctionName string
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionNamespace string
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionQualifier string
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionName string
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionNamespace string
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionName string
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionNamespace string
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceId string
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    ServiceParameters List<ApiGatewayApiServiceParameter>
    The backend service parameters of the API.
    ServiceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    TargetNamespaceId string
    Tsf serverless namespace ID. (In internal testing).
    TargetServices List<ApiGatewayApiTargetService>
    Target type backend resource information. (Internal testing stage).
    TargetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConf
    Target health check configuration. (Internal testing stage).
    TargetServicesLoadBalanceConf double
    Target type load balancing configuration. (Internal testing stage).
    TestLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    TokenTimeout double
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    UserType string
    User type.
    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiGatewayApiId string
    ID of the resource.
    ApiName string
    Custom API name.
    ApiType string
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    AuthRelationApiId string
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    AuthType string
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    ConstantParameters []ApiGatewayApiConstantParameterArgs
    Constant parameter.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    EiamAppId string
    EIAM application ID.
    EiamAppType string
    EIAM application type.
    EiamAuthType string
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    EnableCors bool
    Whether to enable CORS. Default value: true.
    EventBusId string
    Event bus ID.
    IsBase64Encoded bool
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    IsDebugAfterCharge bool
    Charge after starting debugging. (Cloud Market Reserved Fields).
    IsDeleteResponseErrorCodes bool
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    MicroServices []ApiGatewayApiMicroServiceArgs
    API bound microservice list.
    OauthConfig ApiGatewayApiOauthConfigArgs
    OAuth configuration. Effective when AuthType is OAUTH.
    Owner string
    Owner of resources.
    PreLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    ReleaseLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    RequestConfigMethod string
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    RequestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    RequestParameters []ApiGatewayApiRequestParameterArgs
    Frontend request parameters.
    ResponseErrorCodes []ApiGatewayApiResponseErrorCodeArgs
    Custom error code configuration. Must keep at least one after set.
    ResponseFailExample string
    Response failure sample of custom response configuration.
    ResponseSuccessExample string
    Successful response sample of custom response configuration.
    ResponseType string
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    ServiceConfigCosConfig ApiGatewayApiServiceConfigCosConfigArgs
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigMethod string
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    ServiceConfigMockReturnMessage string
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    ServiceConfigPath string
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    ServiceConfigProduct string
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    ServiceConfigScfFunctionName string
    SCF function name. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionNamespace string
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionQualifier string
    SCF function version. This parameter takes effect when service_config_type is SCF.
    ServiceConfigScfFunctionType string
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    ServiceConfigScfIsIntegratedResponse bool
    Whether to enable response integration. Effective when the backend type is SCF.
    ServiceConfigTimeout float64
    API backend service timeout period in seconds. Default value: 5.
    ServiceConfigType string
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    ServiceConfigUpstreamId string
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    ServiceConfigUrl string
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    ServiceConfigVpcId string
    Unique VPC ID.
    ServiceConfigWebsocketCleanupFunctionName string
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionNamespace string
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketCleanupFunctionQualifier string
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionName string
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionNamespace string
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketRegisterFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionName string
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionNamespace string
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceConfigWebsocketTransportFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    ServiceId string
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    ServiceParameters []ApiGatewayApiServiceParameterArgs
    The backend service parameters of the API.
    ServiceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConfArgs
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConfArgs
    Load balancing configuration for microservices.
    TargetNamespaceId string
    Tsf serverless namespace ID. (In internal testing).
    TargetServices []ApiGatewayApiTargetServiceArgs
    Target type backend resource information. (Internal testing stage).
    TargetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConfArgs
    Target health check configuration. (Internal testing stage).
    TargetServicesLoadBalanceConf float64
    Target type load balancing configuration. (Internal testing stage).
    TestLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    TokenTimeout float64
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    UserType string
    User type.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiGatewayApiId String
    ID of the resource.
    apiName String
    Custom API name.
    apiType String
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    authRelationApiId String
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    authType String
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constantParameters List<ApiGatewayApiConstantParameter>
    Constant parameter.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    eiamAppId String
    EIAM application ID.
    eiamAppType String
    EIAM application type.
    eiamAuthType String
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enableCors Boolean
    Whether to enable CORS. Default value: true.
    eventBusId String
    Event bus ID.
    isBase64Encoded Boolean
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    isDebugAfterCharge Boolean
    Charge after starting debugging. (Cloud Market Reserved Fields).
    isDeleteResponseErrorCodes Boolean
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    microServices List<ApiGatewayApiMicroService>
    API bound microservice list.
    oauthConfig ApiGatewayApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    owner String
    Owner of resources.
    preLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    releaseLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    requestConfigMethod String
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    requestConfigPath String
    Request frontend path configuration. Like /user/getinfo.
    requestParameters List<ApiGatewayApiRequestParameter>
    Frontend request parameters.
    responseErrorCodes List<ApiGatewayApiResponseErrorCode>
    Custom error code configuration. Must keep at least one after set.
    responseFailExample String
    Response failure sample of custom response configuration.
    responseSuccessExample String
    Successful response sample of custom response configuration.
    responseType String
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    serviceConfigCosConfig ApiGatewayApiServiceConfigCosConfig
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigMethod String
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    serviceConfigMockReturnMessage String
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    serviceConfigPath String
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    serviceConfigProduct String
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    serviceConfigScfFunctionName String
    SCF function name. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionNamespace String
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionQualifier String
    SCF function version. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionType String
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    serviceConfigScfIsIntegratedResponse Boolean
    Whether to enable response integration. Effective when the backend type is SCF.
    serviceConfigTimeout Double
    API backend service timeout period in seconds. Default value: 5.
    serviceConfigType String
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    serviceConfigUpstreamId String
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigUrl String
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    serviceConfigVpcId String
    Unique VPC ID.
    serviceConfigWebsocketCleanupFunctionName String
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionNamespace String
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionQualifier String
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionName String
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionNamespace String
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionName String
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionNamespace String
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceId String
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    serviceParameters List<ApiGatewayApiServiceParameter>
    The backend service parameters of the API.
    serviceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    serviceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    targetNamespaceId String
    Tsf serverless namespace ID. (In internal testing).
    targetServices List<ApiGatewayApiTargetService>
    Target type backend resource information. (Internal testing stage).
    targetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConf
    Target health check configuration. (Internal testing stage).
    targetServicesLoadBalanceConf Double
    Target type load balancing configuration. (Internal testing stage).
    testLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    tokenTimeout Double
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    userType String
    User type.
    apiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc string
    Custom API description.
    apiGatewayApiId string
    ID of the resource.
    apiName string
    Custom API name.
    apiType string
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    authRelationApiId string
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    authType string
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constantParameters ApiGatewayApiConstantParameter[]
    Constant parameter.
    createTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    eiamAppId string
    EIAM application ID.
    eiamAppType string
    EIAM application type.
    eiamAuthType string
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enableCors boolean
    Whether to enable CORS. Default value: true.
    eventBusId string
    Event bus ID.
    isBase64Encoded boolean
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    isDebugAfterCharge boolean
    Charge after starting debugging. (Cloud Market Reserved Fields).
    isDeleteResponseErrorCodes boolean
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    microServices ApiGatewayApiMicroService[]
    API bound microservice list.
    oauthConfig ApiGatewayApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    owner string
    Owner of resources.
    preLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    releaseLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    requestConfigMethod string
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    requestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    requestParameters ApiGatewayApiRequestParameter[]
    Frontend request parameters.
    responseErrorCodes ApiGatewayApiResponseErrorCode[]
    Custom error code configuration. Must keep at least one after set.
    responseFailExample string
    Response failure sample of custom response configuration.
    responseSuccessExample string
    Successful response sample of custom response configuration.
    responseType string
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    serviceConfigCosConfig ApiGatewayApiServiceConfigCosConfig
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigMethod string
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    serviceConfigMockReturnMessage string
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    serviceConfigPath string
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    serviceConfigProduct string
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    serviceConfigScfFunctionName string
    SCF function name. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionNamespace string
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionQualifier string
    SCF function version. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionType string
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    serviceConfigScfIsIntegratedResponse boolean
    Whether to enable response integration. Effective when the backend type is SCF.
    serviceConfigTimeout number
    API backend service timeout period in seconds. Default value: 5.
    serviceConfigType string
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    serviceConfigUpstreamId string
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigUrl string
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    serviceConfigVpcId string
    Unique VPC ID.
    serviceConfigWebsocketCleanupFunctionName string
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionNamespace string
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionQualifier string
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionName string
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionNamespace string
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionName string
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionNamespace string
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionQualifier string
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceId string
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    serviceParameters ApiGatewayApiServiceParameter[]
    The backend service parameters of the API.
    serviceTsfHealthCheckConf ApiGatewayApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    serviceTsfLoadBalanceConf ApiGatewayApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    targetNamespaceId string
    Tsf serverless namespace ID. (In internal testing).
    targetServices ApiGatewayApiTargetService[]
    Target type backend resource information. (Internal testing stage).
    targetServicesHealthCheckConf ApiGatewayApiTargetServicesHealthCheckConf
    Target health check configuration. (Internal testing stage).
    targetServicesLoadBalanceConf number
    Target type load balancing configuration. (Internal testing stage).
    testLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    tokenTimeout number
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    updateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    userType string
    User type.
    api_business_type str
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    api_desc str
    Custom API description.
    api_gateway_api_id str
    ID of the resource.
    api_name str
    Custom API name.
    api_type str
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    auth_relation_api_id str
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    auth_type str
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constant_parameters Sequence[ApiGatewayApiConstantParameterArgs]
    Constant parameter.
    create_time str
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    eiam_app_id str
    EIAM application ID.
    eiam_app_type str
    EIAM application type.
    eiam_auth_type str
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enable_cors bool
    Whether to enable CORS. Default value: true.
    event_bus_id str
    Event bus ID.
    is_base64_encoded bool
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    is_debug_after_charge bool
    Charge after starting debugging. (Cloud Market Reserved Fields).
    is_delete_response_error_codes bool
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    micro_services Sequence[ApiGatewayApiMicroServiceArgs]
    API bound microservice list.
    oauth_config ApiGatewayApiOauthConfigArgs
    OAuth configuration. Effective when AuthType is OAUTH.
    owner str
    Owner of resources.
    pre_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol str
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    release_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    request_config_method str
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    request_config_path str
    Request frontend path configuration. Like /user/getinfo.
    request_parameters Sequence[ApiGatewayApiRequestParameterArgs]
    Frontend request parameters.
    response_error_codes Sequence[ApiGatewayApiResponseErrorCodeArgs]
    Custom error code configuration. Must keep at least one after set.
    response_fail_example str
    Response failure sample of custom response configuration.
    response_success_example str
    Successful response sample of custom response configuration.
    response_type str
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    service_config_cos_config ApiGatewayApiServiceConfigCosConfigArgs
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    service_config_method str
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    service_config_mock_return_message str
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    service_config_path str
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    service_config_product str
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    service_config_scf_function_name str
    SCF function name. This parameter takes effect when service_config_type is SCF.
    service_config_scf_function_namespace str
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    service_config_scf_function_qualifier str
    SCF function version. This parameter takes effect when service_config_type is SCF.
    service_config_scf_function_type str
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    service_config_scf_is_integrated_response bool
    Whether to enable response integration. Effective when the backend type is SCF.
    service_config_timeout float
    API backend service timeout period in seconds. Default value: 5.
    service_config_type str
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    service_config_upstream_id str
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    service_config_url str
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    service_config_vpc_id str
    Unique VPC ID.
    service_config_websocket_cleanup_function_name str
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_cleanup_function_namespace str
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_cleanup_function_qualifier str
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_register_function_name str
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_register_function_namespace str
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_register_function_qualifier str
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_transport_function_name str
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_transport_function_namespace str
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_config_websocket_transport_function_qualifier str
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    service_id str
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    service_parameters Sequence[ApiGatewayApiServiceParameterArgs]
    The backend service parameters of the API.
    service_tsf_health_check_conf ApiGatewayApiServiceTsfHealthCheckConfArgs
    Health check configuration for microservices.
    service_tsf_load_balance_conf ApiGatewayApiServiceTsfLoadBalanceConfArgs
    Load balancing configuration for microservices.
    target_namespace_id str
    Tsf serverless namespace ID. (In internal testing).
    target_services Sequence[ApiGatewayApiTargetServiceArgs]
    Target type backend resource information. (Internal testing stage).
    target_services_health_check_conf ApiGatewayApiTargetServicesHealthCheckConfArgs
    Target health check configuration. (Internal testing stage).
    target_services_load_balance_conf float
    Target type load balancing configuration. (Internal testing stage).
    test_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    token_timeout float
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    update_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    user_type str
    User type.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiGatewayApiId String
    ID of the resource.
    apiName String
    Custom API name.
    apiType String
    API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL.
    authRelationApiId String
    The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding.
    authType String
    API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE.
    constantParameters List<Property Map>
    Constant parameter.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    eiamAppId String
    EIAM application ID.
    eiamAppType String
    EIAM application type.
    eiamAuthType String
    The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization.
    enableCors Boolean
    Whether to enable CORS. Default value: true.
    eventBusId String
    Event bus ID.
    isBase64Encoded Boolean
    Whether to enable Base64 encoding will only take effect when the backend is scf.
    isDebugAfterCharge Boolean
    Charge after starting debugging. (Cloud Market Reserved Fields).
    isDeleteResponseErrorCodes Boolean
    Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted.
    microServices List<Property Map>
    API bound microservice list.
    oauthConfig Property Map
    OAuth configuration. Effective when AuthType is OAUTH.
    owner String
    Owner of resources.
    preLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    releaseLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    requestConfigMethod String
    Request frontend method configuration. Valid values: GET,POST,PUT,DELETE,HEAD,ANY. Default value: GET.
    requestConfigPath String
    Request frontend path configuration. Like /user/getinfo.
    requestParameters List<Property Map>
    Frontend request parameters.
    responseErrorCodes List<Property Map>
    Custom error code configuration. Must keep at least one after set.
    responseFailExample String
    Response failure sample of custom response configuration.
    responseSuccessExample String
    Successful response sample of custom response configuration.
    responseType String
    Return type. Valid values: HTML, JSON, TEXT, BINARY, XML. Default value: HTML.
    serviceConfigCosConfig Property Map
    API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigMethod String
    API backend service request method, such as GET. If service_config_type is HTTP, this parameter will be required. The frontend request_config_method and backend method service_config_method can be different.
    serviceConfigMockReturnMessage String
    Returned information of API backend mocking. This parameter is required when service_config_type is MOCK.
    serviceConfigPath String
    API backend service path, such as /path. If service_config_type is HTTP, this parameter will be required. The frontend request_config_path and backend path service_config_path can be different.
    serviceConfigProduct String
    Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream.
    serviceConfigScfFunctionName String
    SCF function name. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionNamespace String
    SCF function namespace. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionQualifier String
    SCF function version. This parameter takes effect when service_config_type is SCF.
    serviceConfigScfFunctionType String
    Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP).
    serviceConfigScfIsIntegratedResponse Boolean
    Whether to enable response integration. Effective when the backend type is SCF.
    serviceConfigTimeout Number
    API backend service timeout period in seconds. Default value: 5.
    serviceConfigType String
    The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing).
    serviceConfigUpstreamId String
    Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained.
    serviceConfigUrl String
    The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed.
    serviceConfigVpcId String
    Unique VPC ID.
    serviceConfigWebsocketCleanupFunctionName String
    Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionNamespace String
    Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketCleanupFunctionQualifier String
    Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionName String
    Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionNamespace String
    Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketRegisterFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionName String
    Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionNamespace String
    Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceConfigWebsocketTransportFunctionQualifier String
    Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF.
    serviceId String
    The unique ID of the service where the API is located. Refer to resource tencentcloud.ApiGatewayService.
    serviceParameters List<Property Map>
    The backend service parameters of the API.
    serviceTsfHealthCheckConf Property Map
    Health check configuration for microservices.
    serviceTsfLoadBalanceConf Property Map
    Load balancing configuration for microservices.
    targetNamespaceId String
    Tsf serverless namespace ID. (In internal testing).
    targetServices List<Property Map>
    Target type backend resource information. (Internal testing stage).
    targetServicesHealthCheckConf Property Map
    Target health check configuration. (Internal testing stage).
    targetServicesLoadBalanceConf Number
    Target type load balancing configuration. (Internal testing stage).
    testLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    tokenTimeout Number
    The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    userType String
    User type.

    Supporting Types

    ApiGatewayApiConstantParameter, ApiGatewayApiConstantParameterArgs

    DefaultValue string
    Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Desc string
    Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Name string
    Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Position string
    Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    DefaultValue string
    Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Desc string
    Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Name string
    Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Position string
    Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    defaultValue String
    Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    desc String
    Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name String
    Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    position String
    Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    defaultValue string
    Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    desc string
    Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name string
    Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    position string
    Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    default_value str
    Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    desc str
    Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name str
    Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    position str
    Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    defaultValue String
    Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    desc String
    Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name String
    Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    position String
    Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.

    ApiGatewayApiMicroService, ApiGatewayApiMicroServiceArgs

    ClusterId string
    Micro service cluster.
    MicroServiceName string
    Microservice name.
    NamespaceId string
    Microservice namespace.
    ClusterId string
    Micro service cluster.
    MicroServiceName string
    Microservice name.
    NamespaceId string
    Microservice namespace.
    clusterId String
    Micro service cluster.
    microServiceName String
    Microservice name.
    namespaceId String
    Microservice namespace.
    clusterId string
    Micro service cluster.
    microServiceName string
    Microservice name.
    namespaceId string
    Microservice namespace.
    cluster_id str
    Micro service cluster.
    micro_service_name str
    Microservice name.
    namespace_id str
    Microservice namespace.
    clusterId String
    Micro service cluster.
    microServiceName String
    Microservice name.
    namespaceId String
    Microservice namespace.

    ApiGatewayApiOauthConfig, ApiGatewayApiOauthConfigArgs

    PublicKey string
    Public key, used to verify user tokens.
    TokenLocation string
    Token passes the position.
    LoginRedirectUrl string
    Redirect address, used to guide users in login operations.
    PublicKey string
    Public key, used to verify user tokens.
    TokenLocation string
    Token passes the position.
    LoginRedirectUrl string
    Redirect address, used to guide users in login operations.
    publicKey String
    Public key, used to verify user tokens.
    tokenLocation String
    Token passes the position.
    loginRedirectUrl String
    Redirect address, used to guide users in login operations.
    publicKey string
    Public key, used to verify user tokens.
    tokenLocation string
    Token passes the position.
    loginRedirectUrl string
    Redirect address, used to guide users in login operations.
    public_key str
    Public key, used to verify user tokens.
    token_location str
    Token passes the position.
    login_redirect_url str
    Redirect address, used to guide users in login operations.
    publicKey String
    Public key, used to verify user tokens.
    tokenLocation String
    Token passes the position.
    loginRedirectUrl String
    Redirect address, used to guide users in login operations.

    ApiGatewayApiRequestParameter, ApiGatewayApiRequestParameterArgs

    Name string
    Parameter name.
    Position string
    Parameter location.
    Type string
    Parameter type.
    DefaultValue string
    Parameter default value.
    Desc string
    Parameter description.
    Required bool
    If this parameter required. Default value: false.
    Name string
    Parameter name.
    Position string
    Parameter location.
    Type string
    Parameter type.
    DefaultValue string
    Parameter default value.
    Desc string
    Parameter description.
    Required bool
    If this parameter required. Default value: false.
    name String
    Parameter name.
    position String
    Parameter location.
    type String
    Parameter type.
    defaultValue String
    Parameter default value.
    desc String
    Parameter description.
    required Boolean
    If this parameter required. Default value: false.
    name string
    Parameter name.
    position string
    Parameter location.
    type string
    Parameter type.
    defaultValue string
    Parameter default value.
    desc string
    Parameter description.
    required boolean
    If this parameter required. Default value: false.
    name str
    Parameter name.
    position str
    Parameter location.
    type str
    Parameter type.
    default_value str
    Parameter default value.
    desc str
    Parameter description.
    required bool
    If this parameter required. Default value: false.
    name String
    Parameter name.
    position String
    Parameter location.
    type String
    Parameter type.
    defaultValue String
    Parameter default value.
    desc String
    Parameter description.
    required Boolean
    If this parameter required. Default value: false.

    ApiGatewayApiResponseErrorCode, ApiGatewayApiResponseErrorCodeArgs

    Code double
    Custom response configuration error code.
    Msg string
    Custom response configuration error message.
    ConvertedCode double
    Custom error code conversion.
    Desc string
    Parameter description.
    NeedConvert bool
    Whether to enable error code conversion. Default value: false.
    Code float64
    Custom response configuration error code.
    Msg string
    Custom response configuration error message.
    ConvertedCode float64
    Custom error code conversion.
    Desc string
    Parameter description.
    NeedConvert bool
    Whether to enable error code conversion. Default value: false.
    code Double
    Custom response configuration error code.
    msg String
    Custom response configuration error message.
    convertedCode Double
    Custom error code conversion.
    desc String
    Parameter description.
    needConvert Boolean
    Whether to enable error code conversion. Default value: false.
    code number
    Custom response configuration error code.
    msg string
    Custom response configuration error message.
    convertedCode number
    Custom error code conversion.
    desc string
    Parameter description.
    needConvert boolean
    Whether to enable error code conversion. Default value: false.
    code float
    Custom response configuration error code.
    msg str
    Custom response configuration error message.
    converted_code float
    Custom error code conversion.
    desc str
    Parameter description.
    need_convert bool
    Whether to enable error code conversion. Default value: false.
    code Number
    Custom response configuration error code.
    msg String
    Custom response configuration error message.
    convertedCode Number
    Custom error code conversion.
    desc String
    Parameter description.
    needConvert Boolean
    Whether to enable error code conversion. Default value: false.

    ApiGatewayApiServiceConfigCosConfig, ApiGatewayApiServiceConfigCosConfigArgs

    Action string
    The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained.
    BucketName string
    The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained.
    Authorization bool
    The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained.
    PathMatchMode string
    Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained.
    Action string
    The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained.
    BucketName string
    The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained.
    Authorization bool
    The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained.
    PathMatchMode string
    Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained.
    action String
    The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained.
    bucketName String
    The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained.
    authorization Boolean
    The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained.
    pathMatchMode String
    Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained.
    action string
    The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained.
    bucketName string
    The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained.
    authorization boolean
    The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained.
    pathMatchMode string
    Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained.
    action str
    The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained.
    bucket_name str
    The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained.
    authorization bool
    The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained.
    path_match_mode str
    Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained.
    action String
    The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained.
    bucketName String
    The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained.
    authorization Boolean
    The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained.
    pathMatchMode String
    Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained.

    ApiGatewayApiServiceParameter, ApiGatewayApiServiceParameterArgs

    DefaultValue string
    The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Name string
    The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained.
    Position string
    The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterDesc string
    Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterName string
    The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterPosition string
    The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterType string
    The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    DefaultValue string
    The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    Name string
    The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained.
    Position string
    The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterDesc string
    Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterName string
    The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterPosition string
    The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    RelevantRequestParameterType string
    The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    defaultValue String
    The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name String
    The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained.
    position String
    The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterDesc String
    Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterName String
    The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterPosition String
    The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterType String
    The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    defaultValue string
    The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name string
    The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained.
    position string
    The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterDesc string
    Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterName string
    The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterPosition string
    The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterType string
    The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    default_value str
    The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name str
    The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained.
    position str
    The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevant_request_parameter_desc str
    Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevant_request_parameter_name str
    The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevant_request_parameter_position str
    The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevant_request_parameter_type str
    The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    defaultValue String
    The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    name String
    The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained.
    position String
    The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterDesc String
    Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterName String
    The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterPosition String
    The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.
    relevantRequestParameterType String
    The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained.

    ApiGatewayApiServiceTsfHealthCheckConf, ApiGatewayApiServiceTsfHealthCheckConfArgs

    ErrorThresholdPercentage double
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    IsHealthCheck bool
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    RequestVolumeThreshold double
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    SleepWindowInMilliseconds double
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    ErrorThresholdPercentage float64
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    IsHealthCheck bool
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    RequestVolumeThreshold float64
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    SleepWindowInMilliseconds float64
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    errorThresholdPercentage Double
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    isHealthCheck Boolean
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    requestVolumeThreshold Double
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleepWindowInMilliseconds Double
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    errorThresholdPercentage number
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    isHealthCheck boolean
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    requestVolumeThreshold number
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleepWindowInMilliseconds number
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    error_threshold_percentage float
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    is_health_check bool
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    request_volume_threshold float
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleep_window_in_milliseconds float
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    errorThresholdPercentage Number
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    isHealthCheck Boolean
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    requestVolumeThreshold Number
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleepWindowInMilliseconds Number
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.

    ApiGatewayApiServiceTsfLoadBalanceConf, ApiGatewayApiServiceTsfLoadBalanceConfArgs

    IsLoadBalance bool
    Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained.
    Method string
    Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained.
    SessionStickRequired bool
    Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained.
    SessionStickTimeout double
    Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained.
    IsLoadBalance bool
    Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained.
    Method string
    Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained.
    SessionStickRequired bool
    Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained.
    SessionStickTimeout float64
    Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained.
    isLoadBalance Boolean
    Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained.
    method String
    Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained.
    sessionStickRequired Boolean
    Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained.
    sessionStickTimeout Double
    Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained.
    isLoadBalance boolean
    Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained.
    method string
    Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained.
    sessionStickRequired boolean
    Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained.
    sessionStickTimeout number
    Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained.
    is_load_balance bool
    Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained.
    method str
    Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained.
    session_stick_required bool
    Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained.
    session_stick_timeout float
    Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained.
    isLoadBalance Boolean
    Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained.
    method String
    Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained.
    sessionStickRequired Boolean
    Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained.
    sessionStickTimeout Number
    Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained.

    ApiGatewayApiTargetService, ApiGatewayApiTargetServiceArgs

    HostIp string
    Host IP of the CVM.
    VmIp string
    vm ip.
    VmPort double
    vm port.
    VpcId string
    vpc id.
    DockerIp string
    docker ip.
    HostIp string
    Host IP of the CVM.
    VmIp string
    vm ip.
    VmPort float64
    vm port.
    VpcId string
    vpc id.
    DockerIp string
    docker ip.
    hostIp String
    Host IP of the CVM.
    vmIp String
    vm ip.
    vmPort Double
    vm port.
    vpcId String
    vpc id.
    dockerIp String
    docker ip.
    hostIp string
    Host IP of the CVM.
    vmIp string
    vm ip.
    vmPort number
    vm port.
    vpcId string
    vpc id.
    dockerIp string
    docker ip.
    host_ip str
    Host IP of the CVM.
    vm_ip str
    vm ip.
    vm_port float
    vm port.
    vpc_id str
    vpc id.
    docker_ip str
    docker ip.
    hostIp String
    Host IP of the CVM.
    vmIp String
    vm ip.
    vmPort Number
    vm port.
    vpcId String
    vpc id.
    dockerIp String
    docker ip.

    ApiGatewayApiTargetServicesHealthCheckConf, ApiGatewayApiTargetServicesHealthCheckConfArgs

    ErrorThresholdPercentage double
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    IsHealthCheck bool
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    RequestVolumeThreshold double
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    SleepWindowInMilliseconds double
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    ErrorThresholdPercentage float64
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    IsHealthCheck bool
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    RequestVolumeThreshold float64
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    SleepWindowInMilliseconds float64
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    errorThresholdPercentage Double
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    isHealthCheck Boolean
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    requestVolumeThreshold Double
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleepWindowInMilliseconds Double
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    errorThresholdPercentage number
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    isHealthCheck boolean
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    requestVolumeThreshold number
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleepWindowInMilliseconds number
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    error_threshold_percentage float
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    is_health_check bool
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    request_volume_threshold float
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleep_window_in_milliseconds float
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.
    errorThresholdPercentage Number
    Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained.
    isHealthCheck Boolean
    Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained.
    requestVolumeThreshold Number
    Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained.
    sleepWindowInMilliseconds Number
    Window size.Note: This field may return null, indicating that a valid value cannot be obtained.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud