1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getApiGatewayApis
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getApiGatewayApis

Start a Neo task
Explain and create a tencentcloud.getApiGatewayApis resource
tencentcloud logo
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query API gateway APIs.

    Example Usage

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

const service = new tencentcloud.ApiGatewayService("service", {
    serviceName: "ck",
    protocol: "http&https",
    serviceDesc: "your nice service",
    netTypes: [
        "INNER",
        "OUTER",
    ],
    ipVersion: "IPv4",
});
const api = new tencentcloud.ApiGatewayApi("api", {
    serviceId: service.apiGatewayServiceId,
    apiName: "hello",
    apiDesc: "my hello api",
    authType: "NONE",
    protocol: "HTTP",
    enableCors: true,
    requestConfigPath: "/user/info",
    requestConfigMethod: "GET",
    serviceConfigType: "HTTP",
    serviceConfigTimeout: 15,
    serviceConfigUrl: "http://www.qq.com",
    serviceConfigPath: "/user",
    serviceConfigMethod: "GET",
    responseType: "HTML",
    responseSuccessExample: "success",
    responseFailExample: "fail",
});
const id = tencentcloud.getApiGatewayApisOutput({
    serviceId: service.apiGatewayServiceId,
    apiId: api.apiGatewayApiId,
});
const name = tencentcloud.getApiGatewayApisOutput({
    serviceId: service.apiGatewayServiceId,
    apiName: api.apiName,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

service = tencentcloud.ApiGatewayService("service",
    service_name="ck",
    protocol="http&https",
    service_desc="your nice service",
    net_types=[
        "INNER",
        "OUTER",
    ],
    ip_version="IPv4")
api = tencentcloud.ApiGatewayApi("api",
    service_id=service.api_gateway_service_id,
    api_name="hello",
    api_desc="my hello api",
    auth_type="NONE",
    protocol="HTTP",
    enable_cors=True,
    request_config_path="/user/info",
    request_config_method="GET",
    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")
id = tencentcloud.get_api_gateway_apis_output(service_id=service.api_gateway_service_id,
    api_id=api.api_gateway_api_id)
name = tencentcloud.get_api_gateway_apis_output(service_id=service.api_gateway_service_id,
    api_name=api.api_name)

    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 {
		service, err := tencentcloud.NewApiGatewayService(ctx, "service", &tencentcloud.ApiGatewayServiceArgs{
			ServiceName: pulumi.String("ck"),
			Protocol:    pulumi.String("http&https"),
			ServiceDesc: pulumi.String("your nice service"),
			NetTypes: pulumi.StringArray{
				pulumi.String("INNER"),
				pulumi.String("OUTER"),
			},
			IpVersion: pulumi.String("IPv4"),
		})
		if err != nil {
			return err
		}
		api, err := tencentcloud.NewApiGatewayApi(ctx, "api", &tencentcloud.ApiGatewayApiArgs{
			ServiceId:              service.ApiGatewayServiceId,
			ApiName:                pulumi.String("hello"),
			ApiDesc:                pulumi.String("my hello api"),
			AuthType:               pulumi.String("NONE"),
			Protocol:               pulumi.String("HTTP"),
			EnableCors:             pulumi.Bool(true),
			RequestConfigPath:      pulumi.String("/user/info"),
			RequestConfigMethod:    pulumi.String("GET"),
			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"),
		})
		if err != nil {
			return err
		}
		_ = tencentcloud.GetApiGatewayApisOutput(ctx, tencentcloud.GetApiGatewayApisOutputArgs{
			ServiceId: service.ApiGatewayServiceId,
			ApiId:     api.ApiGatewayApiId,
		}, nil)
		_ = tencentcloud.GetApiGatewayApisOutput(ctx, tencentcloud.GetApiGatewayApisOutputArgs{
			ServiceId: service.ApiGatewayServiceId,
			ApiName:   api.ApiName,
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var service = new Tencentcloud.ApiGatewayService("service", new()
    {
        ServiceName = "ck",
        Protocol = "http&https",
        ServiceDesc = "your nice service",
        NetTypes = new[]
        {
            "INNER",
            "OUTER",
        },
        IpVersion = "IPv4",
    });

    var api = new Tencentcloud.ApiGatewayApi("api", new()
    {
        ServiceId = service.ApiGatewayServiceId,
        ApiName = "hello",
        ApiDesc = "my hello api",
        AuthType = "NONE",
        Protocol = "HTTP",
        EnableCors = true,
        RequestConfigPath = "/user/info",
        RequestConfigMethod = "GET",
        ServiceConfigType = "HTTP",
        ServiceConfigTimeout = 15,
        ServiceConfigUrl = "http://www.qq.com",
        ServiceConfigPath = "/user",
        ServiceConfigMethod = "GET",
        ResponseType = "HTML",
        ResponseSuccessExample = "success",
        ResponseFailExample = "fail",
    });

    var id = Tencentcloud.GetApiGatewayApis.Invoke(new()
    {
        ServiceId = service.ApiGatewayServiceId,
        ApiId = api.ApiGatewayApiId,
    });

    var name = Tencentcloud.GetApiGatewayApis.Invoke(new()
    {
        ServiceId = service.ApiGatewayServiceId,
        ApiName = api.ApiName,
    });

});

    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.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetApiGatewayApisArgs;
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 service = new ApiGatewayService("service", ApiGatewayServiceArgs.builder()
            .serviceName("ck")
            .protocol("http&https")
            .serviceDesc("your nice service")
            .netTypes(            
                "INNER",
                "OUTER")
            .ipVersion("IPv4")
            .build());

        var api = new ApiGatewayApi("api", ApiGatewayApiArgs.builder()
            .serviceId(service.apiGatewayServiceId())
            .apiName("hello")
            .apiDesc("my hello api")
            .authType("NONE")
            .protocol("HTTP")
            .enableCors(true)
            .requestConfigPath("/user/info")
            .requestConfigMethod("GET")
            .serviceConfigType("HTTP")
            .serviceConfigTimeout(15.0)
            .serviceConfigUrl("http://www.qq.com")
            .serviceConfigPath("/user")
            .serviceConfigMethod("GET")
            .responseType("HTML")
            .responseSuccessExample("success")
            .responseFailExample("fail")
            .build());

        final var id = TencentcloudFunctions.getApiGatewayApis(GetApiGatewayApisArgs.builder()
            .serviceId(service.apiGatewayServiceId())
            .apiId(api.apiGatewayApiId())
            .build());

        final var name = TencentcloudFunctions.getApiGatewayApis(GetApiGatewayApisArgs.builder()
            .serviceId(service.apiGatewayServiceId())
            .apiName(api.apiName())
            .build());

    }
}

    resources:
  service:
    type: tencentcloud:ApiGatewayService
    properties:
      serviceName: ck
      protocol: http&https
      serviceDesc: your nice service
      netTypes:
        - INNER
        - OUTER
      ipVersion: IPv4
  api:
    type: tencentcloud:ApiGatewayApi
    properties:
      serviceId: ${service.apiGatewayServiceId}
      apiName: hello
      apiDesc: my hello api
      authType: NONE
      protocol: HTTP
      enableCors: true
      requestConfigPath: /user/info
      requestConfigMethod: GET
      serviceConfigType: HTTP
      serviceConfigTimeout: 15
      serviceConfigUrl: http://www.qq.com
      serviceConfigPath: /user
      serviceConfigMethod: GET
      responseType: HTML
      responseSuccessExample: success
      responseFailExample: fail
variables:
  id:
    fn::invoke:
      function: tencentcloud:getApiGatewayApis
      arguments:
        serviceId: ${service.apiGatewayServiceId}
        apiId: ${api.apiGatewayApiId}
  name:
    fn::invoke:
      function: tencentcloud:getApiGatewayApis
      arguments:
        serviceId: ${service.apiGatewayServiceId}
        apiName: ${api.apiName}

    Using getApiGatewayApis

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

    function getApiGatewayApis(args: GetApiGatewayApisArgs, opts?: InvokeOptions): Promise<GetApiGatewayApisResult>
function getApiGatewayApisOutput(args: GetApiGatewayApisOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayApisResult>
    def get_api_gateway_apis(api_id: Optional[str] = None,
                         api_name: Optional[str] = None,
                         id: Optional[str] = None,
                         result_output_file: Optional[str] = None,
                         service_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetApiGatewayApisResult
def get_api_gateway_apis_output(api_id: Optional[pulumi.Input[str]] = None,
                         api_name: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         result_output_file: Optional[pulumi.Input[str]] = None,
                         service_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayApisResult]
    func GetApiGatewayApis(ctx *Context, args *GetApiGatewayApisArgs, opts ...InvokeOption) (*GetApiGatewayApisResult, error)
func GetApiGatewayApisOutput(ctx *Context, args *GetApiGatewayApisOutputArgs, opts ...InvokeOption) GetApiGatewayApisResultOutput

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

    public static class GetApiGatewayApis 
{
    public static Task<GetApiGatewayApisResult> InvokeAsync(GetApiGatewayApisArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayApisResult> Invoke(GetApiGatewayApisInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiGatewayApisResult> getApiGatewayApis(GetApiGatewayApisArgs args, InvokeOptions options)
public static Output<GetApiGatewayApisResult> getApiGatewayApis(GetApiGatewayApisArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ServiceId string
    Service ID for query.
    ApiId string
    Created API ID.
    ApiName string
    Custom API name.
    Id string
    ResultOutputFile string
    Used to save results.
    ServiceId string
    Service ID for query.
    ApiId string
    Created API ID.
    ApiName string
    Custom API name.
    Id string
    ResultOutputFile string
    Used to save results.
    serviceId String
    Service ID for query.
    apiId String
    Created API ID.
    apiName String
    Custom API name.
    id String
    resultOutputFile String
    Used to save results.
    serviceId string
    Service ID for query.
    apiId string
    Created API ID.
    apiName string
    Custom API name.
    id string
    resultOutputFile string
    Used to save results.
    service_id str
    Service ID for query.
    api_id str
    Created API ID.
    api_name str
    Custom API name.
    id str
    result_output_file str
    Used to save results.
    serviceId String
    Service ID for query.
    apiId String
    Created API ID.
    apiName String
    Custom API name.
    id String
    resultOutputFile String
    Used to save results.

    getApiGatewayApis Result

    The following output properties are available:

    Id string
    Lists List<GetApiGatewayApisList>
    A list of APIs.
    ServiceId string
    Which service this API belongs. Refer to resource tencentcloud.ApiGatewayService.
    ApiId string
    ApiName string
    Custom API name.
    ResultOutputFile string
    Id string
    Lists []GetApiGatewayApisList
    A list of APIs.
    ServiceId string
    Which service this API belongs. Refer to resource tencentcloud.ApiGatewayService.
    ApiId string
    ApiName string
    Custom API name.
    ResultOutputFile string
    id String
    lists List<GetApiGatewayApisList>
    A list of APIs.
    serviceId String
    Which service this API belongs. Refer to resource tencentcloud.ApiGatewayService.
    apiId String
    apiName String
    Custom API name.
    resultOutputFile String
    id string
    lists GetApiGatewayApisList[]
    A list of APIs.
    serviceId string
    Which service this API belongs. Refer to resource tencentcloud.ApiGatewayService.
    apiId string
    apiName string
    Custom API name.
    resultOutputFile string
    id str
    lists Sequence[GetApiGatewayApisList]
    A list of APIs.
    service_id str
    Which service this API belongs. Refer to resource tencentcloud.ApiGatewayService.
    api_id str
    api_name str
    Custom API name.
    result_output_file str
    id String
    lists List<Property Map>
    A list of APIs.
    serviceId String
    Which service this API belongs. Refer to resource tencentcloud.ApiGatewayService.
    apiId String
    apiName String
    Custom API name.
    resultOutputFile String

    Supporting Types

    GetApiGatewayApisList

    ApiDesc string
    Custom API description.
    ApiName string
    Custom API name.
    AuthType string
    API authentication type. Valid values: SECRET, NONE. SECRET means key pair authentication, NONE means no authentication.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    EnableCors bool
    Whether to enable CORS.
    ModifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    Protocol string
    API frontend request type, such as HTTP,WEBSOCKET.
    RequestConfigMethod string
    Request frontend method configuration. Like GET,POST,PUT,DELETE,HEAD,ANY.
    RequestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    RequestParameters List<GetApiGatewayApisListRequestParameter>
    Frontend request parameters.
    ResponseErrorCodes List<GetApiGatewayApisListResponseErrorCode>
    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.
    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.
    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. This parameter takes effect when VPC is enabled. Currently, only clb is supported.
    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.
    ServiceConfigTimeout double
    API backend service timeout period in seconds.
    ServiceConfigType string
    API backend service type.
    ServiceConfigUrl string
    API backend service url. This parameter is required when service_config_type is HTTP.
    ServiceConfigVpcId string
    Unique VPC ID.
    ServiceId string
    Service ID for query.
    ApiDesc string
    Custom API description.
    ApiName string
    Custom API name.
    AuthType string
    API authentication type. Valid values: SECRET, NONE. SECRET means key pair authentication, NONE means no authentication.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    EnableCors bool
    Whether to enable CORS.
    ModifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    Protocol string
    API frontend request type, such as HTTP,WEBSOCKET.
    RequestConfigMethod string
    Request frontend method configuration. Like GET,POST,PUT,DELETE,HEAD,ANY.
    RequestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    RequestParameters []GetApiGatewayApisListRequestParameter
    Frontend request parameters.
    ResponseErrorCodes []GetApiGatewayApisListResponseErrorCode
    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.
    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.
    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. This parameter takes effect when VPC is enabled. Currently, only clb is supported.
    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.
    ServiceConfigTimeout float64
    API backend service timeout period in seconds.
    ServiceConfigType string
    API backend service type.
    ServiceConfigUrl string
    API backend service url. This parameter is required when service_config_type is HTTP.
    ServiceConfigVpcId string
    Unique VPC ID.
    ServiceId string
    Service ID for query.
    apiDesc String
    Custom API description.
    apiName String
    Custom API name.
    authType String
    API authentication type. Valid values: SECRET, NONE. SECRET means key pair authentication, NONE means no authentication.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    enableCors Boolean
    Whether to enable CORS.
    modifyTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    protocol String
    API frontend request type, such as HTTP,WEBSOCKET.
    requestConfigMethod String
    Request frontend method configuration. Like GET,POST,PUT,DELETE,HEAD,ANY.
    requestConfigPath String
    Request frontend path configuration. Like /user/getinfo.
    requestParameters List<GetApiGatewayApisListRequestParameter>
    Frontend request parameters.
    responseErrorCodes List<GetApiGatewayApisListResponseErrorCode>
    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.
    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.
    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. This parameter takes effect when VPC is enabled. Currently, only clb is supported.
    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.
    serviceConfigTimeout Double
    API backend service timeout period in seconds.
    serviceConfigType String
    API backend service type.
    serviceConfigUrl String
    API backend service url. This parameter is required when service_config_type is HTTP.
    serviceConfigVpcId String
    Unique VPC ID.
    serviceId String
    Service ID for query.
    apiDesc string
    Custom API description.
    apiName string
    Custom API name.
    authType string
    API authentication type. Valid values: SECRET, NONE. SECRET means key pair authentication, NONE means no authentication.
    createTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    enableCors boolean
    Whether to enable CORS.
    modifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    protocol string
    API frontend request type, such as HTTP,WEBSOCKET.
    requestConfigMethod string
    Request frontend method configuration. Like GET,POST,PUT,DELETE,HEAD,ANY.
    requestConfigPath string
    Request frontend path configuration. Like /user/getinfo.
    requestParameters GetApiGatewayApisListRequestParameter[]
    Frontend request parameters.
    responseErrorCodes GetApiGatewayApisListResponseErrorCode[]
    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.
    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.
    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. This parameter takes effect when VPC is enabled. Currently, only clb is supported.
    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.
    serviceConfigTimeout number
    API backend service timeout period in seconds.
    serviceConfigType string
    API backend service type.
    serviceConfigUrl string
    API backend service url. This parameter is required when service_config_type is HTTP.
    serviceConfigVpcId string
    Unique VPC ID.
    serviceId string
    Service ID for query.
    api_desc str
    Custom API description.
    api_name str
    Custom API name.
    auth_type str
    API authentication type. Valid values: SECRET, NONE. SECRET means key pair authentication, NONE means no authentication.
    create_time str
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    enable_cors bool
    Whether to enable CORS.
    modify_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    protocol str
    API frontend request type, such as HTTP,WEBSOCKET.
    request_config_method str
    Request frontend method configuration. Like GET,POST,PUT,DELETE,HEAD,ANY.
    request_config_path str
    Request frontend path configuration. Like /user/getinfo.
    request_parameters Sequence[GetApiGatewayApisListRequestParameter]
    Frontend request parameters.
    response_error_codes Sequence[GetApiGatewayApisListResponseErrorCode]
    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.
    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.
    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. This parameter takes effect when VPC is enabled. Currently, only clb is supported.
    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_timeout float
    API backend service timeout period in seconds.
    service_config_type str
    API backend service type.
    service_config_url str
    API backend service url. This parameter is required when service_config_type is HTTP.
    service_config_vpc_id str
    Unique VPC ID.
    service_id str
    Service ID for query.
    apiDesc String
    Custom API description.
    apiName String
    Custom API name.
    authType String
    API authentication type. Valid values: SECRET, NONE. SECRET means key pair authentication, NONE means no authentication.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    enableCors Boolean
    Whether to enable CORS.
    modifyTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    protocol String
    API frontend request type, such as HTTP,WEBSOCKET.
    requestConfigMethod String
    Request frontend method configuration. Like GET,POST,PUT,DELETE,HEAD,ANY.
    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.
    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.
    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. This parameter takes effect when VPC is enabled. Currently, only clb is supported.
    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.
    serviceConfigTimeout Number
    API backend service timeout period in seconds.
    serviceConfigType String
    API backend service type.
    serviceConfigUrl String
    API backend service url. This parameter is required when service_config_type is HTTP.
    serviceConfigVpcId String
    Unique VPC ID.
    serviceId String
    Service ID for query.

    GetApiGatewayApisListRequestParameter

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

    GetApiGatewayApisListResponseErrorCode

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate