Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ApiGatewayImportOpenApi
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ApiGatewayImportOpenApi

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a apiGateway import_open_api

    Example Usage

    Import open Api by YAML

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

const example = new tencentcloud.ApiGatewayImportOpenApi("example", {
    content: `info:
  title: keep-service
  version: 1.0.1
openapi: 3.0.0
paths:
  /api/test:
    get:
      description: desc
      operationId: test
      responses:
        '200':
          content:
            text/html:
              example: '200'
          description: '200'
        default:
          content:
            text/html:
              example: '400'
          description: '400'
      x-apigw-api-business-type: NORMAL
      x-apigw-api-type: NORMAL
      x-apigw-backend:
        ServiceConfig:
          Method: GET
          Path: /test
          Url: http://domain.com
        ServiceType: HTTP
      x-apigw-cors: false
      x-apigw-protocol: HTTP
      x-apigw-service-timeout: 15

`,
    contentVersion: "openAPI",
    encodeType: "YAML",
    serviceId: "service-nxz6yync",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ApiGatewayImportOpenApi("example",
    content="""info:
  title: keep-service
  version: 1.0.1
openapi: 3.0.0
paths:
  /api/test:
    get:
      description: desc
      operationId: test
      responses:
        '200':
          content:
            text/html:
              example: '200'
          description: '200'
        default:
          content:
            text/html:
              example: '400'
          description: '400'
      x-apigw-api-business-type: NORMAL
      x-apigw-api-type: NORMAL
      x-apigw-backend:
        ServiceConfig:
          Method: GET
          Path: /test
          Url: http://domain.com
        ServiceType: HTTP
      x-apigw-cors: false
      x-apigw-protocol: HTTP
      x-apigw-service-timeout: 15

""",
    content_version="openAPI",
    encode_type="YAML",
    service_id="service-nxz6yync")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewApiGatewayImportOpenApi(ctx, "example", &tencentcloud.ApiGatewayImportOpenApiArgs{
			Content: pulumi.String(`info:
  title: keep-service
  version: 1.0.1
openapi: 3.0.0
paths:
  /api/test:
    get:
      description: desc
      operationId: test
      responses:
        '200':
          content:
            text/html:
              example: '200'
          description: '200'
        default:
          content:
            text/html:
              example: '400'
          description: '400'
      x-apigw-api-business-type: NORMAL
      x-apigw-api-type: NORMAL
      x-apigw-backend:
        ServiceConfig:
          Method: GET
          Path: /test
          Url: http://domain.com
        ServiceType: HTTP
      x-apigw-cors: false
      x-apigw-protocol: HTTP
      x-apigw-service-timeout: 15

`),
			ContentVersion: pulumi.String("openAPI"),
			EncodeType:     pulumi.String("YAML"),
			ServiceId:      pulumi.String("service-nxz6yync"),
		})
		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.ApiGatewayImportOpenApi("example", new()
    {
        Content = @"info:
  title: keep-service
  version: 1.0.1
openapi: 3.0.0
paths:
  /api/test:
    get:
      description: desc
      operationId: test
      responses:
        '200':
          content:
            text/html:
              example: '200'
          description: '200'
        default:
          content:
            text/html:
              example: '400'
          description: '400'
      x-apigw-api-business-type: NORMAL
      x-apigw-api-type: NORMAL
      x-apigw-backend:
        ServiceConfig:
          Method: GET
          Path: /test
          Url: http://domain.com
        ServiceType: HTTP
      x-apigw-cors: false
      x-apigw-protocol: HTTP
      x-apigw-service-timeout: 15

",
        ContentVersion = "openAPI",
        EncodeType = "YAML",
        ServiceId = "service-nxz6yync",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayImportOpenApi;
import com.pulumi.tencentcloud.ApiGatewayImportOpenApiArgs;
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 ApiGatewayImportOpenApi("example", ApiGatewayImportOpenApiArgs.builder()
            .content("""
info:
  title: keep-service
  version: 1.0.1
openapi: 3.0.0
paths:
  /api/test:
    get:
      description: desc
      operationId: test
      responses:
        '200':
          content:
            text/html:
              example: '200'
          description: '200'
        default:
          content:
            text/html:
              example: '400'
          description: '400'
      x-apigw-api-business-type: NORMAL
      x-apigw-api-type: NORMAL
      x-apigw-backend:
        ServiceConfig:
          Method: GET
          Path: /test
          Url: http://domain.com
        ServiceType: HTTP
      x-apigw-cors: false
      x-apigw-protocol: HTTP
      x-apigw-service-timeout: 15

            """)
            .contentVersion("openAPI")
            .encodeType("YAML")
            .serviceId("service-nxz6yync")
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ApiGatewayImportOpenApi
    properties:
      content: |+
        info:
          title: keep-service
          version: 1.0.1
        openapi: 3.0.0
        paths:
          /api/test:
            get:
              description: desc
              operationId: test
              responses:
                '200':
                  content:
                    text/html:
                      example: '200'
                  description: '200'
                default:
                  content:
                    text/html:
                      example: '400'
                  description: '400'
              x-apigw-api-business-type: NORMAL
              x-apigw-api-type: NORMAL
              x-apigw-backend:
                ServiceConfig:
                  Method: GET
                  Path: /test
                  Url: http://domain.com
                ServiceType: HTTP
              x-apigw-cors: false
              x-apigw-protocol: HTTP
              x-apigw-service-timeout: 15        

      contentVersion: openAPI
      encodeType: YAML
      serviceId: service-nxz6yync

    Import open Api by JSON

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

const example = new tencentcloud.ApiGatewayImportOpenApi("example", {
    content: "{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"keep-service\", \"version\": \"1.0.1\"}, \"paths\": {\"/api/test\": {\"get\": {\"operationId\": \"test\", \"description\": \"desc\", \"responses\": {\"200\": {\"description\": \"200\", \"content\": {\"text/html\": {\"example\": \"200\"}}}, \"default\": {\"content\": {\"text/html\": {\"example\": \"400\"}}, \"description\": \"400\"}}, \"x-apigw-api-type\": \"NORMAL\", \"x-apigw-api-business-type\": \"NORMAL\", \"x-apigw-protocol\": \"HTTP\", \"x-apigw-cors\": false, \"x-apigw-service-timeout\": 15, \"x-apigw-backend\": {\"ServiceType\": \"HTTP\", \"ServiceConfig\": {\"Url\": \"http://domain.com\", \"Path\": \"/test\", \"Method\": \"GET\"}}}}}}",
    contentVersion: "openAPI",
    encodeType: "JSON",
    serviceId: "service-nxz6yync",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ApiGatewayImportOpenApi("example",
    content="{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"keep-service\", \"version\": \"1.0.1\"}, \"paths\": {\"/api/test\": {\"get\": {\"operationId\": \"test\", \"description\": \"desc\", \"responses\": {\"200\": {\"description\": \"200\", \"content\": {\"text/html\": {\"example\": \"200\"}}}, \"default\": {\"content\": {\"text/html\": {\"example\": \"400\"}}, \"description\": \"400\"}}, \"x-apigw-api-type\": \"NORMAL\", \"x-apigw-api-business-type\": \"NORMAL\", \"x-apigw-protocol\": \"HTTP\", \"x-apigw-cors\": false, \"x-apigw-service-timeout\": 15, \"x-apigw-backend\": {\"ServiceType\": \"HTTP\", \"ServiceConfig\": {\"Url\": \"http://domain.com\", \"Path\": \"/test\", \"Method\": \"GET\"}}}}}}",
    content_version="openAPI",
    encode_type="JSON",
    service_id="service-nxz6yync")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewApiGatewayImportOpenApi(ctx, "example", &tencentcloud.ApiGatewayImportOpenApiArgs{
			Content:        pulumi.String("{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"keep-service\", \"version\": \"1.0.1\"}, \"paths\": {\"/api/test\": {\"get\": {\"operationId\": \"test\", \"description\": \"desc\", \"responses\": {\"200\": {\"description\": \"200\", \"content\": {\"text/html\": {\"example\": \"200\"}}}, \"default\": {\"content\": {\"text/html\": {\"example\": \"400\"}}, \"description\": \"400\"}}, \"x-apigw-api-type\": \"NORMAL\", \"x-apigw-api-business-type\": \"NORMAL\", \"x-apigw-protocol\": \"HTTP\", \"x-apigw-cors\": false, \"x-apigw-service-timeout\": 15, \"x-apigw-backend\": {\"ServiceType\": \"HTTP\", \"ServiceConfig\": {\"Url\": \"http://domain.com\", \"Path\": \"/test\", \"Method\": \"GET\"}}}}}}"),
			ContentVersion: pulumi.String("openAPI"),
			EncodeType:     pulumi.String("JSON"),
			ServiceId:      pulumi.String("service-nxz6yync"),
		})
		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.ApiGatewayImportOpenApi("example", new()
    {
        Content = "{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"keep-service\", \"version\": \"1.0.1\"}, \"paths\": {\"/api/test\": {\"get\": {\"operationId\": \"test\", \"description\": \"desc\", \"responses\": {\"200\": {\"description\": \"200\", \"content\": {\"text/html\": {\"example\": \"200\"}}}, \"default\": {\"content\": {\"text/html\": {\"example\": \"400\"}}, \"description\": \"400\"}}, \"x-apigw-api-type\": \"NORMAL\", \"x-apigw-api-business-type\": \"NORMAL\", \"x-apigw-protocol\": \"HTTP\", \"x-apigw-cors\": false, \"x-apigw-service-timeout\": 15, \"x-apigw-backend\": {\"ServiceType\": \"HTTP\", \"ServiceConfig\": {\"Url\": \"http://domain.com\", \"Path\": \"/test\", \"Method\": \"GET\"}}}}}}",
        ContentVersion = "openAPI",
        EncodeType = "JSON",
        ServiceId = "service-nxz6yync",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayImportOpenApi;
import com.pulumi.tencentcloud.ApiGatewayImportOpenApiArgs;
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 ApiGatewayImportOpenApi("example", ApiGatewayImportOpenApiArgs.builder()
            .content("{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"keep-service\", \"version\": \"1.0.1\"}, \"paths\": {\"/api/test\": {\"get\": {\"operationId\": \"test\", \"description\": \"desc\", \"responses\": {\"200\": {\"description\": \"200\", \"content\": {\"text/html\": {\"example\": \"200\"}}}, \"default\": {\"content\": {\"text/html\": {\"example\": \"400\"}}, \"description\": \"400\"}}, \"x-apigw-api-type\": \"NORMAL\", \"x-apigw-api-business-type\": \"NORMAL\", \"x-apigw-protocol\": \"HTTP\", \"x-apigw-cors\": false, \"x-apigw-service-timeout\": 15, \"x-apigw-backend\": {\"ServiceType\": \"HTTP\", \"ServiceConfig\": {\"Url\": \"http://domain.com\", \"Path\": \"/test\", \"Method\": \"GET\"}}}}}}")
            .contentVersion("openAPI")
            .encodeType("JSON")
            .serviceId("service-nxz6yync")
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ApiGatewayImportOpenApi
    properties:
      content: '{"openapi": "3.0.0", "info": {"title": "keep-service", "version": "1.0.1"}, "paths": {"/api/test": {"get": {"operationId": "test", "description": "desc", "responses": {"200": {"description": "200", "content": {"text/html": {"example": "200"}}}, "default": {"content": {"text/html": {"example": "400"}}, "description": "400"}}, "x-apigw-api-type": "NORMAL", "x-apigw-api-business-type": "NORMAL", "x-apigw-protocol": "HTTP", "x-apigw-cors": false, "x-apigw-service-timeout": 15, "x-apigw-backend": {"ServiceType": "HTTP", "ServiceConfig": {"Url": "http://domain.com", "Path": "/test", "Method": "GET"}}}}}}'
      contentVersion: openAPI
      encodeType: JSON
      serviceId: service-nxz6yync

    Create ApiGatewayImportOpenApi Resource

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

    Constructor syntax

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

@overload
def ApiGatewayImportOpenApi(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            content: Optional[str] = None,
                            service_id: Optional[str] = None,
                            api_gateway_import_open_api_id: Optional[str] = None,
                            content_version: Optional[str] = None,
                            encode_type: Optional[str] = None)
    func NewApiGatewayImportOpenApi(ctx *Context, name string, args ApiGatewayImportOpenApiArgs, opts ...ResourceOption) (*ApiGatewayImportOpenApi, error)
    public ApiGatewayImportOpenApi(string name, ApiGatewayImportOpenApiArgs args, CustomResourceOptions? opts = null)
    public ApiGatewayImportOpenApi(String name, ApiGatewayImportOpenApiArgs args)
public ApiGatewayImportOpenApi(String name, ApiGatewayImportOpenApiArgs args, CustomResourceOptions options)

    type: tencentcloud:ApiGatewayImportOpenApi
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 ApiGatewayImportOpenApiArgs
    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 ApiGatewayImportOpenApiArgs
    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 ApiGatewayImportOpenApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayImportOpenApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayImportOpenApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ApiGatewayImportOpenApi 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 ApiGatewayImportOpenApi resource accepts the following input properties:

    Content string
    OpenAPI body content.
    ServiceId string
    The unique ID of the service where the API is located.
    ApiGatewayImportOpenApiId string
    ID of the resource.
    ContentVersion string
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    EncodeType string
    The Content format can only be YAML or JSON, and the default is YAML.
    Content string
    OpenAPI body content.
    ServiceId string
    The unique ID of the service where the API is located.
    ApiGatewayImportOpenApiId string
    ID of the resource.
    ContentVersion string
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    EncodeType string
    The Content format can only be YAML or JSON, and the default is YAML.
    content String
    OpenAPI body content.
    serviceId String
    The unique ID of the service where the API is located.
    apiGatewayImportOpenApiId String
    ID of the resource.
    contentVersion String
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    encodeType String
    The Content format can only be YAML or JSON, and the default is YAML.
    content string
    OpenAPI body content.
    serviceId string
    The unique ID of the service where the API is located.
    apiGatewayImportOpenApiId string
    ID of the resource.
    contentVersion string
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    encodeType string
    The Content format can only be YAML or JSON, and the default is YAML.
    content str
    OpenAPI body content.
    service_id str
    The unique ID of the service where the API is located.
    api_gateway_import_open_api_id str
    ID of the resource.
    content_version str
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    encode_type str
    The Content format can only be YAML or JSON, and the default is YAML.
    content String
    OpenAPI body content.
    serviceId String
    The unique ID of the service where the API is located.
    apiGatewayImportOpenApiId String
    ID of the resource.
    contentVersion String
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    encodeType String
    The Content format can only be YAML or JSON, and the default is YAML.

    Outputs

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

    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiId string
    Custom Api Id.
    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<ApiGatewayImportOpenApiConstantParameter>
    Constant parameter.
    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. Default value: true.
    Id string
    The provider-assigned unique ID for this managed resource.
    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<ApiGatewayImportOpenApiMicroService>
    API bound microservice list.
    OauthConfigs List<ApiGatewayImportOpenApiOauthConfig>
    OAuth configuration. Effective when AuthType is OAUTH.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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<ApiGatewayImportOpenApiRequestParameter>
    Frontend request parameters.
    ResponseErrorCodes List<ApiGatewayImportOpenApiResponseErrorCode>
    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.
    ServiceConfigCosConfigs List<ApiGatewayImportOpenApiServiceConfigCosConfig>
    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<ApiGatewayImportOpenApiServiceParameter>
    The backend service parameters of the API.
    ServiceTsfHealthCheckConfs List<ApiGatewayImportOpenApiServiceTsfHealthCheckConf>
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConfs List<ApiGatewayImportOpenApiServiceTsfLoadBalanceConf>
    Load balancing configuration for microservices.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiId string
    Custom Api Id.
    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 []ApiGatewayImportOpenApiConstantParameter
    Constant parameter.
    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. Default value: true.
    Id string
    The provider-assigned unique ID for this managed resource.
    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 []ApiGatewayImportOpenApiMicroService
    API bound microservice list.
    OauthConfigs []ApiGatewayImportOpenApiOauthConfig
    OAuth configuration. Effective when AuthType is OAUTH.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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 []ApiGatewayImportOpenApiRequestParameter
    Frontend request parameters.
    ResponseErrorCodes []ApiGatewayImportOpenApiResponseErrorCode
    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.
    ServiceConfigCosConfigs []ApiGatewayImportOpenApiServiceConfigCosConfig
    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 []ApiGatewayImportOpenApiServiceParameter
    The backend service parameters of the API.
    ServiceTsfHealthCheckConfs []ApiGatewayImportOpenApiServiceTsfHealthCheckConf
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConfs []ApiGatewayImportOpenApiServiceTsfLoadBalanceConf
    Load balancing configuration for microservices.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiId String
    Custom Api Id.
    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<ApiGatewayImportOpenApiConstantParameter>
    Constant parameter.
    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. Default value: true.
    id String
    The provider-assigned unique ID for this managed resource.
    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<ApiGatewayImportOpenApiMicroService>
    API bound microservice list.
    oauthConfigs List<ApiGatewayImportOpenApiOauthConfig>
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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<ApiGatewayImportOpenApiRequestParameter>
    Frontend request parameters.
    responseErrorCodes List<ApiGatewayImportOpenApiResponseErrorCode>
    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.
    serviceConfigCosConfigs List<ApiGatewayImportOpenApiServiceConfigCosConfig>
    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<ApiGatewayImportOpenApiServiceParameter>
    The backend service parameters of the API.
    serviceTsfHealthCheckConfs List<ApiGatewayImportOpenApiServiceTsfHealthCheckConf>
    Health check configuration for microservices.
    serviceTsfLoadBalanceConfs List<ApiGatewayImportOpenApiServiceTsfLoadBalanceConf>
    Load balancing configuration for microservices.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    apiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc string
    Custom API description.
    apiId string
    Custom Api Id.
    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 ApiGatewayImportOpenApiConstantParameter[]
    Constant parameter.
    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. Default value: true.
    id string
    The provider-assigned unique ID for this managed resource.
    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 ApiGatewayImportOpenApiMicroService[]
    API bound microservice list.
    oauthConfigs ApiGatewayImportOpenApiOauthConfig[]
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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 ApiGatewayImportOpenApiRequestParameter[]
    Frontend request parameters.
    responseErrorCodes ApiGatewayImportOpenApiResponseErrorCode[]
    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.
    serviceConfigCosConfigs ApiGatewayImportOpenApiServiceConfigCosConfig[]
    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 ApiGatewayImportOpenApiServiceParameter[]
    The backend service parameters of the API.
    serviceTsfHealthCheckConfs ApiGatewayImportOpenApiServiceTsfHealthCheckConf[]
    Health check configuration for microservices.
    serviceTsfLoadBalanceConfs ApiGatewayImportOpenApiServiceTsfLoadBalanceConf[]
    Load balancing configuration for microservices.
    updateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    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_id str
    Custom Api Id.
    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[ApiGatewayImportOpenApiConstantParameter]
    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.
    enable_cors bool
    Whether to enable CORS. Default value: true.
    id str
    The provider-assigned unique ID for this managed resource.
    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[ApiGatewayImportOpenApiMicroService]
    API bound microservice list.
    oauth_configs Sequence[ApiGatewayImportOpenApiOauthConfig]
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol str
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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[ApiGatewayImportOpenApiRequestParameter]
    Frontend request parameters.
    response_error_codes Sequence[ApiGatewayImportOpenApiResponseErrorCode]
    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_configs Sequence[ApiGatewayImportOpenApiServiceConfigCosConfig]
    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[ApiGatewayImportOpenApiServiceParameter]
    The backend service parameters of the API.
    service_tsf_health_check_confs Sequence[ApiGatewayImportOpenApiServiceTsfHealthCheckConf]
    Health check configuration for microservices.
    service_tsf_load_balance_confs Sequence[ApiGatewayImportOpenApiServiceTsfLoadBalanceConf]
    Load balancing configuration for microservices.
    update_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiId String
    Custom Api Id.
    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.
    enableCors Boolean
    Whether to enable CORS. Default value: true.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    oauthConfigs List<Property Map>
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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.
    serviceConfigCosConfigs List<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.
    serviceTsfHealthCheckConfs List<Property Map>
    Health check configuration for microservices.
    serviceTsfLoadBalanceConfs List<Property Map>
    Load balancing configuration for microservices.
    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 ApiGatewayImportOpenApi Resource

    Get an existing ApiGatewayImportOpenApi 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?: ApiGatewayImportOpenApiState, opts?: CustomResourceOptions): ApiGatewayImportOpenApi
    @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_import_open_api_id: Optional[str] = None,
        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[ApiGatewayImportOpenApiConstantParameterArgs]] = None,
        content: Optional[str] = None,
        content_version: Optional[str] = None,
        create_time: Optional[str] = None,
        enable_cors: Optional[bool] = None,
        encode_type: 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[ApiGatewayImportOpenApiMicroServiceArgs]] = None,
        oauth_configs: Optional[Sequence[ApiGatewayImportOpenApiOauthConfigArgs]] = None,
        protocol: Optional[str] = None,
        request_config_method: Optional[str] = None,
        request_config_path: Optional[str] = None,
        request_parameters: Optional[Sequence[ApiGatewayImportOpenApiRequestParameterArgs]] = None,
        response_error_codes: Optional[Sequence[ApiGatewayImportOpenApiResponseErrorCodeArgs]] = None,
        response_fail_example: Optional[str] = None,
        response_success_example: Optional[str] = None,
        response_type: Optional[str] = None,
        service_config_cos_configs: Optional[Sequence[ApiGatewayImportOpenApiServiceConfigCosConfigArgs]] = 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[ApiGatewayImportOpenApiServiceParameterArgs]] = None,
        service_tsf_health_check_confs: Optional[Sequence[ApiGatewayImportOpenApiServiceTsfHealthCheckConfArgs]] = None,
        service_tsf_load_balance_confs: Optional[Sequence[ApiGatewayImportOpenApiServiceTsfLoadBalanceConfArgs]] = None,
        update_time: Optional[str] = None) -> ApiGatewayImportOpenApi
    func GetApiGatewayImportOpenApi(ctx *Context, name string, id IDInput, state *ApiGatewayImportOpenApiState, opts ...ResourceOption) (*ApiGatewayImportOpenApi, error)
    public static ApiGatewayImportOpenApi Get(string name, Input<string> id, ApiGatewayImportOpenApiState? state, CustomResourceOptions? opts = null)
    public static ApiGatewayImportOpenApi get(String name, Output<String> id, ApiGatewayImportOpenApiState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ApiGatewayImportOpenApi    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.
    ApiGatewayImportOpenApiId string
    ID of the resource.
    ApiId string
    Custom Api Id.
    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<ApiGatewayImportOpenApiConstantParameter>
    Constant parameter.
    Content string
    OpenAPI body content.
    ContentVersion string
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    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. Default value: true.
    EncodeType string
    The Content format can only be YAML or JSON, and the default is YAML.
    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<ApiGatewayImportOpenApiMicroService>
    API bound microservice list.
    OauthConfigs List<ApiGatewayImportOpenApiOauthConfig>
    OAuth configuration. Effective when AuthType is OAUTH.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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<ApiGatewayImportOpenApiRequestParameter>
    Frontend request parameters.
    ResponseErrorCodes List<ApiGatewayImportOpenApiResponseErrorCode>
    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.
    ServiceConfigCosConfigs List<ApiGatewayImportOpenApiServiceConfigCosConfig>
    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.
    ServiceParameters List<ApiGatewayImportOpenApiServiceParameter>
    The backend service parameters of the API.
    ServiceTsfHealthCheckConfs List<ApiGatewayImportOpenApiServiceTsfHealthCheckConf>
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConfs List<ApiGatewayImportOpenApiServiceTsfLoadBalanceConf>
    Load balancing configuration for microservices.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    ApiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    ApiDesc string
    Custom API description.
    ApiGatewayImportOpenApiId string
    ID of the resource.
    ApiId string
    Custom Api Id.
    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 []ApiGatewayImportOpenApiConstantParameterArgs
    Constant parameter.
    Content string
    OpenAPI body content.
    ContentVersion string
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    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. Default value: true.
    EncodeType string
    The Content format can only be YAML or JSON, and the default is YAML.
    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 []ApiGatewayImportOpenApiMicroServiceArgs
    API bound microservice list.
    OauthConfigs []ApiGatewayImportOpenApiOauthConfigArgs
    OAuth configuration. Effective when AuthType is OAUTH.
    Protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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 []ApiGatewayImportOpenApiRequestParameterArgs
    Frontend request parameters.
    ResponseErrorCodes []ApiGatewayImportOpenApiResponseErrorCodeArgs
    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.
    ServiceConfigCosConfigs []ApiGatewayImportOpenApiServiceConfigCosConfigArgs
    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.
    ServiceParameters []ApiGatewayImportOpenApiServiceParameterArgs
    The backend service parameters of the API.
    ServiceTsfHealthCheckConfs []ApiGatewayImportOpenApiServiceTsfHealthCheckConfArgs
    Health check configuration for microservices.
    ServiceTsfLoadBalanceConfs []ApiGatewayImportOpenApiServiceTsfLoadBalanceConfArgs
    Load balancing configuration for microservices.
    UpdateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiGatewayImportOpenApiId String
    ID of the resource.
    apiId String
    Custom Api Id.
    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<ApiGatewayImportOpenApiConstantParameter>
    Constant parameter.
    content String
    OpenAPI body content.
    contentVersion String
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    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. Default value: true.
    encodeType String
    The Content format can only be YAML or JSON, and the default is YAML.
    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<ApiGatewayImportOpenApiMicroService>
    API bound microservice list.
    oauthConfigs List<ApiGatewayImportOpenApiOauthConfig>
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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<ApiGatewayImportOpenApiRequestParameter>
    Frontend request parameters.
    responseErrorCodes List<ApiGatewayImportOpenApiResponseErrorCode>
    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.
    serviceConfigCosConfigs List<ApiGatewayImportOpenApiServiceConfigCosConfig>
    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.
    serviceParameters List<ApiGatewayImportOpenApiServiceParameter>
    The backend service parameters of the API.
    serviceTsfHealthCheckConfs List<ApiGatewayImportOpenApiServiceTsfHealthCheckConf>
    Health check configuration for microservices.
    serviceTsfLoadBalanceConfs List<ApiGatewayImportOpenApiServiceTsfLoadBalanceConf>
    Load balancing configuration for microservices.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    apiBusinessType string
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc string
    Custom API description.
    apiGatewayImportOpenApiId string
    ID of the resource.
    apiId string
    Custom Api Id.
    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 ApiGatewayImportOpenApiConstantParameter[]
    Constant parameter.
    content string
    OpenAPI body content.
    contentVersion string
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    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. Default value: true.
    encodeType string
    The Content format can only be YAML or JSON, and the default is YAML.
    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 ApiGatewayImportOpenApiMicroService[]
    API bound microservice list.
    oauthConfigs ApiGatewayImportOpenApiOauthConfig[]
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol string
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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 ApiGatewayImportOpenApiRequestParameter[]
    Frontend request parameters.
    responseErrorCodes ApiGatewayImportOpenApiResponseErrorCode[]
    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.
    serviceConfigCosConfigs ApiGatewayImportOpenApiServiceConfigCosConfig[]
    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.
    serviceParameters ApiGatewayImportOpenApiServiceParameter[]
    The backend service parameters of the API.
    serviceTsfHealthCheckConfs ApiGatewayImportOpenApiServiceTsfHealthCheckConf[]
    Health check configuration for microservices.
    serviceTsfLoadBalanceConfs ApiGatewayImportOpenApiServiceTsfLoadBalanceConf[]
    Load balancing configuration for microservices.
    updateTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    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_import_open_api_id str
    ID of the resource.
    api_id str
    Custom Api Id.
    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[ApiGatewayImportOpenApiConstantParameterArgs]
    Constant parameter.
    content str
    OpenAPI body content.
    content_version str
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    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. Default value: true.
    encode_type str
    The Content format can only be YAML or JSON, and the default is YAML.
    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[ApiGatewayImportOpenApiMicroServiceArgs]
    API bound microservice list.
    oauth_configs Sequence[ApiGatewayImportOpenApiOauthConfigArgs]
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol str
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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[ApiGatewayImportOpenApiRequestParameterArgs]
    Frontend request parameters.
    response_error_codes Sequence[ApiGatewayImportOpenApiResponseErrorCodeArgs]
    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_configs Sequence[ApiGatewayImportOpenApiServiceConfigCosConfigArgs]
    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.
    service_parameters Sequence[ApiGatewayImportOpenApiServiceParameterArgs]
    The backend service parameters of the API.
    service_tsf_health_check_confs Sequence[ApiGatewayImportOpenApiServiceTsfHealthCheckConfArgs]
    Health check configuration for microservices.
    service_tsf_load_balance_confs Sequence[ApiGatewayImportOpenApiServiceTsfLoadBalanceConfArgs]
    Load balancing configuration for microservices.
    update_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    apiBusinessType String
    When auth_type is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API.
    apiDesc String
    Custom API description.
    apiGatewayImportOpenApiId String
    ID of the resource.
    apiId String
    Custom Api Id.
    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.
    content String
    OpenAPI body content.
    contentVersion String
    The Content version defaults to OpenAPI and currently only supports OpenAPI.
    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. Default value: true.
    encodeType String
    The Content format can only be YAML or JSON, and the default is YAML.
    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.
    oauthConfigs List<Property Map>
    OAuth configuration. Effective when AuthType is OAUTH.
    protocol String
    API frontend request type. Valid values: HTTP, WEBSOCKET. Default value: HTTP.
    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.
    serviceConfigCosConfigs List<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.
    serviceParameters List<Property Map>
    The backend service parameters of the API.
    serviceTsfHealthCheckConfs List<Property Map>
    Health check configuration for microservices.
    serviceTsfLoadBalanceConfs List<Property Map>
    Load balancing configuration for microservices.
    updateTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.

    Supporting Types

    ApiGatewayImportOpenApiConstantParameter, ApiGatewayImportOpenApiConstantParameterArgs

    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.
    Desc string
    Parameter description.
    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.
    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.
    Desc string
    Parameter description.
    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.
    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.
    desc String
    Parameter description.
    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.
    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.
    desc string
    Parameter description.
    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.
    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.
    desc str
    Parameter description.
    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.
    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.
    desc String
    Parameter description.
    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.

    ApiGatewayImportOpenApiMicroService, ApiGatewayImportOpenApiMicroServiceArgs

    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.

    ApiGatewayImportOpenApiOauthConfig, ApiGatewayImportOpenApiOauthConfigArgs

    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.
    publicKey string
    Public key, used to verify user tokens.
    tokenLocation string
    Token passes the position.
    login_redirect_url str
    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.
    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.

    ApiGatewayImportOpenApiRequestParameter, ApiGatewayImportOpenApiRequestParameterArgs

    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.
    Desc string
    Parameter description.
    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.
    Required bool
    If this parameter required. Default value: false.
    Type string
    Parameter type.
    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.
    Desc string
    Parameter description.
    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.
    Required bool
    If this parameter required. Default value: false.
    Type string
    Parameter type.
    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.
    desc String
    Parameter description.
    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.
    required Boolean
    If this parameter required. Default value: false.
    type String
    Parameter type.
    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.
    desc string
    Parameter description.
    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.
    required boolean
    If this parameter required. Default value: false.
    type string
    Parameter type.
    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.
    desc str
    Parameter description.
    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.
    required bool
    If this parameter required. Default value: false.
    type str
    Parameter type.
    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.
    desc String
    Parameter description.
    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.
    required Boolean
    If this parameter required. Default value: false.
    type String
    Parameter type.

    ApiGatewayImportOpenApiResponseErrorCode, ApiGatewayImportOpenApiResponseErrorCodeArgs

    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.

    ApiGatewayImportOpenApiServiceConfigCosConfig, ApiGatewayImportOpenApiServiceConfigCosConfigArgs

    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.
    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.
    BucketName string
    The bucket name of the API backend COS.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.
    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.
    BucketName string
    The bucket name of the API backend COS.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.
    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.
    bucketName String
    The bucket name of the API backend COS.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.
    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.
    bucketName string
    The bucket name of the API backend COS.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.
    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.
    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.
    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.
    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.
    bucketName String
    The bucket name of the API backend COS.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.

    ApiGatewayImportOpenApiServiceParameter, ApiGatewayImportOpenApiServiceParameterArgs

    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.

    ApiGatewayImportOpenApiServiceTsfHealthCheckConf, ApiGatewayImportOpenApiServiceTsfHealthCheckConfArgs

    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.

    ApiGatewayImportOpenApiServiceTsfLoadBalanceConf, ApiGatewayImportOpenApiServiceTsfLoadBalanceConfArgs

    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.

    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.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud