Alibaba Cloud v3.76.0, Apr 8 25

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.apigateway.Api

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

Basic Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new alicloud.apigateway.Group("example", {
    name: "tf-example",
    description: "tf-example",
    basePath: "/",
});
const exampleApi = new alicloud.apigateway.Api("example", {
    groupId: example.id,
    name: "tf-example",
    description: "tf-example",
    authType: "APP",
    forceNonceCheck: false,
    requestConfig: {
        protocol: "HTTP",
        method: "GET",
        path: "/example/path",
        mode: "MAPPING",
    },
    serviceType: "HTTP",
    httpServiceConfig: {
        address: "http://apigateway-backend.alicloudapi.com:8080",
        method: "GET",
        path: "/web/cloudapi",
        timeout: 12,
        aoneName: "cloudapi-openapi",
    },
    requestParameters: [{
        name: "example",
        type: "STRING",
        required: "OPTIONAL",
        "in": "QUERY",
        inService: "QUERY",
        nameService: "exampleservice",
    }],
    stageNames: [
        "RELEASE",
        "TEST",
    ],
});

import pulumi
import pulumi_alicloud as alicloud

example = alicloud.apigateway.Group("example",
    name="tf-example",
    description="tf-example",
    base_path="/")
example_api = alicloud.apigateway.Api("example",
    group_id=example.id,
    name="tf-example",
    description="tf-example",
    auth_type="APP",
    force_nonce_check=False,
    request_config={
        "protocol": "HTTP",
        "method": "GET",
        "path": "/example/path",
        "mode": "MAPPING",
    },
    service_type="HTTP",
    http_service_config={
        "address": "http://apigateway-backend.alicloudapi.com:8080",
        "method": "GET",
        "path": "/web/cloudapi",
        "timeout": 12,
        "aone_name": "cloudapi-openapi",
    },
    request_parameters=[{
        "name": "example",
        "type": "STRING",
        "required": "OPTIONAL",
        "in_": "QUERY",
        "in_service": "QUERY",
        "name_service": "exampleservice",
    }],
    stage_names=[
        "RELEASE",
        "TEST",
    ])

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := apigateway.NewGroup(ctx, "example", &apigateway.GroupArgs{
			Name:        pulumi.String("tf-example"),
			Description: pulumi.String("tf-example"),
			BasePath:    pulumi.String("/"),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewApi(ctx, "example", &apigateway.ApiArgs{
			GroupId:         example.ID(),
			Name:            pulumi.String("tf-example"),
			Description:     pulumi.String("tf-example"),
			AuthType:        pulumi.String("APP"),
			ForceNonceCheck: pulumi.Bool(false),
			RequestConfig: &apigateway.ApiRequestConfigArgs{
				Protocol: pulumi.String("HTTP"),
				Method:   pulumi.String("GET"),
				Path:     pulumi.String("/example/path"),
				Mode:     pulumi.String("MAPPING"),
			},
			ServiceType: pulumi.String("HTTP"),
			HttpServiceConfig: &apigateway.ApiHttpServiceConfigArgs{
				Address:  pulumi.String("http://apigateway-backend.alicloudapi.com:8080"),
				Method:   pulumi.String("GET"),
				Path:     pulumi.String("/web/cloudapi"),
				Timeout:  pulumi.Int(12),
				AoneName: pulumi.String("cloudapi-openapi"),
			},
			RequestParameters: apigateway.ApiRequestParameterArray{
				&apigateway.ApiRequestParameterArgs{
					Name:        pulumi.String("example"),
					Type:        pulumi.String("STRING"),
					Required:    pulumi.String("OPTIONAL"),
					In:          pulumi.String("QUERY"),
					InService:   pulumi.String("QUERY"),
					NameService: pulumi.String("exampleservice"),
				},
			},
			StageNames: pulumi.StringArray{
				pulumi.String("RELEASE"),
				pulumi.String("TEST"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new AliCloud.ApiGateway.Group("example", new()
    {
        Name = "tf-example",
        Description = "tf-example",
        BasePath = "/",
    });

    var exampleApi = new AliCloud.ApiGateway.Api("example", new()
    {
        GroupId = example.Id,
        Name = "tf-example",
        Description = "tf-example",
        AuthType = "APP",
        ForceNonceCheck = false,
        RequestConfig = new AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs
        {
            Protocol = "HTTP",
            Method = "GET",
            Path = "/example/path",
            Mode = "MAPPING",
        },
        ServiceType = "HTTP",
        HttpServiceConfig = new AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs
        {
            Address = "http://apigateway-backend.alicloudapi.com:8080",
            Method = "GET",
            Path = "/web/cloudapi",
            Timeout = 12,
            AoneName = "cloudapi-openapi",
        },
        RequestParameters = new[]
        {
            new AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs
            {
                Name = "example",
                Type = "STRING",
                Required = "OPTIONAL",
                In = "QUERY",
                InService = "QUERY",
                NameService = "exampleservice",
            },
        },
        StageNames = new[]
        {
            "RELEASE",
            "TEST",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Group;
import com.pulumi.alicloud.apigateway.GroupArgs;
import com.pulumi.alicloud.apigateway.Api;
import com.pulumi.alicloud.apigateway.ApiArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiHttpServiceConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestParameterArgs;
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 Group("example", GroupArgs.builder()
            .name("tf-example")
            .description("tf-example")
            .basePath("/")
            .build());

        var exampleApi = new Api("exampleApi", ApiArgs.builder()
            .groupId(example.id())
            .name("tf-example")
            .description("tf-example")
            .authType("APP")
            .forceNonceCheck(false)
            .requestConfig(ApiRequestConfigArgs.builder()
                .protocol("HTTP")
                .method("GET")
                .path("/example/path")
                .mode("MAPPING")
                .build())
            .serviceType("HTTP")
            .httpServiceConfig(ApiHttpServiceConfigArgs.builder()
                .address("http://apigateway-backend.alicloudapi.com:8080")
                .method("GET")
                .path("/web/cloudapi")
                .timeout(12)
                .aoneName("cloudapi-openapi")
                .build())
            .requestParameters(ApiRequestParameterArgs.builder()
                .name("example")
                .type("STRING")
                .required("OPTIONAL")
                .in("QUERY")
                .inService("QUERY")
                .nameService("exampleservice")
                .build())
            .stageNames(            
                "RELEASE",
                "TEST")
            .build());

    }
}

resources:
  example:
    type: alicloud:apigateway:Group
    properties:
      name: tf-example
      description: tf-example
      basePath: /
  exampleApi:
    type: alicloud:apigateway:Api
    name: example
    properties:
      groupId: ${example.id}
      name: tf-example
      description: tf-example
      authType: APP
      forceNonceCheck: false
      requestConfig:
        protocol: HTTP
        method: GET
        path: /example/path
        mode: MAPPING
      serviceType: HTTP
      httpServiceConfig:
        address: http://apigateway-backend.alicloudapi.com:8080
        method: GET
        path: /web/cloudapi
        timeout: 12
        aoneName: cloudapi-openapi
      requestParameters:
        - name: example
          type: STRING
          required: OPTIONAL
          in: QUERY
          inService: QUERY
          nameService: exampleservice
      stageNames:
        - RELEASE
        - TEST

Create Api Resource

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

new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);

@overload
def Api(resource_name: str,
        args: ApiArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Api(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        group_id: Optional[str] = None,
        service_type: Optional[str] = None,
        description: Optional[str] = None,
        request_config: Optional[ApiRequestConfigArgs] = None,
        auth_type: Optional[str] = None,
        http_service_config: Optional[ApiHttpServiceConfigArgs] = None,
        force_nonce_check: Optional[bool] = None,
        http_vpc_service_config: Optional[ApiHttpVpcServiceConfigArgs] = None,
        mock_service_config: Optional[ApiMockServiceConfigArgs] = None,
        name: Optional[str] = None,
        fc_service_config: Optional[ApiFcServiceConfigArgs] = None,
        request_parameters: Optional[Sequence[ApiRequestParameterArgs]] = None,
        constant_parameters: Optional[Sequence[ApiConstantParameterArgs]] = None,
        stage_names: Optional[Sequence[str]] = None,
        system_parameters: Optional[Sequence[ApiSystemParameterArgs]] = None)

func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)

public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)

public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)

type: alicloud:apigateway:Api
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 ApiArgs: 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 ApiArgs: 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 ApiArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ApiArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ApiArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var apiResource = new AliCloud.ApiGateway.Api("apiResource", new()
{
    GroupId = "string",
    ServiceType = "string",
    Description = "string",
    RequestConfig = new AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs
    {
        Method = "string",
        Mode = "string",
        Path = "string",
        Protocol = "string",
        BodyFormat = "string",
    },
    AuthType = "string",
    HttpServiceConfig = new AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs
    {
        Address = "string",
        Method = "string",
        Path = "string",
        Timeout = 0,
        AoneName = "string",
        ContentTypeCategory = "string",
        ContentTypeValue = "string",
    },
    ForceNonceCheck = false,
    HttpVpcServiceConfig = new AliCloud.ApiGateway.Inputs.ApiHttpVpcServiceConfigArgs
    {
        Method = "string",
        Name = "string",
        Path = "string",
        Timeout = 0,
        AoneName = "string",
        ContentTypeCategory = "string",
        ContentTypeValue = "string",
        VpcScheme = "string",
    },
    MockServiceConfig = new AliCloud.ApiGateway.Inputs.ApiMockServiceConfigArgs
    {
        Result = "string",
        AoneName = "string",
    },
    Name = "string",
    FcServiceConfig = new AliCloud.ApiGateway.Inputs.ApiFcServiceConfigArgs
    {
        ArnRole = "string",
        Region = "string",
        Timeout = 0,
        FunctionBaseUrl = "string",
        FunctionName = "string",
        FunctionType = "string",
        Method = "string",
        OnlyBusinessPath = false,
        Path = "string",
        Qualifier = "string",
        ServiceName = "string",
    },
    RequestParameters = new[]
    {
        new AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs
        {
            In = "string",
            InService = "string",
            Name = "string",
            NameService = "string",
            Required = "string",
            Type = "string",
            DefaultValue = "string",
            Description = "string",
        },
    },
    ConstantParameters = new[]
    {
        new AliCloud.ApiGateway.Inputs.ApiConstantParameterArgs
        {
            In = "string",
            Name = "string",
            Value = "string",
            Description = "string",
        },
    },
    StageNames = new[]
    {
        "string",
    },
    SystemParameters = new[]
    {
        new AliCloud.ApiGateway.Inputs.ApiSystemParameterArgs
        {
            In = "string",
            Name = "string",
            NameService = "string",
        },
    },
});

example, err := apigateway.NewApi(ctx, "apiResource", &apigateway.ApiArgs{
	GroupId:     pulumi.String("string"),
	ServiceType: pulumi.String("string"),
	Description: pulumi.String("string"),
	RequestConfig: &apigateway.ApiRequestConfigArgs{
		Method:     pulumi.String("string"),
		Mode:       pulumi.String("string"),
		Path:       pulumi.String("string"),
		Protocol:   pulumi.String("string"),
		BodyFormat: pulumi.String("string"),
	},
	AuthType: pulumi.String("string"),
	HttpServiceConfig: &apigateway.ApiHttpServiceConfigArgs{
		Address:             pulumi.String("string"),
		Method:              pulumi.String("string"),
		Path:                pulumi.String("string"),
		Timeout:             pulumi.Int(0),
		AoneName:            pulumi.String("string"),
		ContentTypeCategory: pulumi.String("string"),
		ContentTypeValue:    pulumi.String("string"),
	},
	ForceNonceCheck: pulumi.Bool(false),
	HttpVpcServiceConfig: &apigateway.ApiHttpVpcServiceConfigArgs{
		Method:              pulumi.String("string"),
		Name:                pulumi.String("string"),
		Path:                pulumi.String("string"),
		Timeout:             pulumi.Int(0),
		AoneName:            pulumi.String("string"),
		ContentTypeCategory: pulumi.String("string"),
		ContentTypeValue:    pulumi.String("string"),
		VpcScheme:           pulumi.String("string"),
	},
	MockServiceConfig: &apigateway.ApiMockServiceConfigArgs{
		Result:   pulumi.String("string"),
		AoneName: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	FcServiceConfig: &apigateway.ApiFcServiceConfigArgs{
		ArnRole:          pulumi.String("string"),
		Region:           pulumi.String("string"),
		Timeout:          pulumi.Int(0),
		FunctionBaseUrl:  pulumi.String("string"),
		FunctionName:     pulumi.String("string"),
		FunctionType:     pulumi.String("string"),
		Method:           pulumi.String("string"),
		OnlyBusinessPath: pulumi.Bool(false),
		Path:             pulumi.String("string"),
		Qualifier:        pulumi.String("string"),
		ServiceName:      pulumi.String("string"),
	},
	RequestParameters: apigateway.ApiRequestParameterArray{
		&apigateway.ApiRequestParameterArgs{
			In:           pulumi.String("string"),
			InService:    pulumi.String("string"),
			Name:         pulumi.String("string"),
			NameService:  pulumi.String("string"),
			Required:     pulumi.String("string"),
			Type:         pulumi.String("string"),
			DefaultValue: pulumi.String("string"),
			Description:  pulumi.String("string"),
		},
	},
	ConstantParameters: apigateway.ApiConstantParameterArray{
		&apigateway.ApiConstantParameterArgs{
			In:          pulumi.String("string"),
			Name:        pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	StageNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	SystemParameters: apigateway.ApiSystemParameterArray{
		&apigateway.ApiSystemParameterArgs{
			In:          pulumi.String("string"),
			Name:        pulumi.String("string"),
			NameService: pulumi.String("string"),
		},
	},
})

var apiResource = new Api("apiResource", ApiArgs.builder()
    .groupId("string")
    .serviceType("string")
    .description("string")
    .requestConfig(ApiRequestConfigArgs.builder()
        .method("string")
        .mode("string")
        .path("string")
        .protocol("string")
        .bodyFormat("string")
        .build())
    .authType("string")
    .httpServiceConfig(ApiHttpServiceConfigArgs.builder()
        .address("string")
        .method("string")
        .path("string")
        .timeout(0)
        .aoneName("string")
        .contentTypeCategory("string")
        .contentTypeValue("string")
        .build())
    .forceNonceCheck(false)
    .httpVpcServiceConfig(ApiHttpVpcServiceConfigArgs.builder()
        .method("string")
        .name("string")
        .path("string")
        .timeout(0)
        .aoneName("string")
        .contentTypeCategory("string")
        .contentTypeValue("string")
        .vpcScheme("string")
        .build())
    .mockServiceConfig(ApiMockServiceConfigArgs.builder()
        .result("string")
        .aoneName("string")
        .build())
    .name("string")
    .fcServiceConfig(ApiFcServiceConfigArgs.builder()
        .arnRole("string")
        .region("string")
        .timeout(0)
        .functionBaseUrl("string")
        .functionName("string")
        .functionType("string")
        .method("string")
        .onlyBusinessPath(false)
        .path("string")
        .qualifier("string")
        .serviceName("string")
        .build())
    .requestParameters(ApiRequestParameterArgs.builder()
        .in("string")
        .inService("string")
        .name("string")
        .nameService("string")
        .required("string")
        .type("string")
        .defaultValue("string")
        .description("string")
        .build())
    .constantParameters(ApiConstantParameterArgs.builder()
        .in("string")
        .name("string")
        .value("string")
        .description("string")
        .build())
    .stageNames("string")
    .systemParameters(ApiSystemParameterArgs.builder()
        .in("string")
        .name("string")
        .nameService("string")
        .build())
    .build());

api_resource = alicloud.apigateway.Api("apiResource",
    group_id="string",
    service_type="string",
    description="string",
    request_config={
        "method": "string",
        "mode": "string",
        "path": "string",
        "protocol": "string",
        "body_format": "string",
    },
    auth_type="string",
    http_service_config={
        "address": "string",
        "method": "string",
        "path": "string",
        "timeout": 0,
        "aone_name": "string",
        "content_type_category": "string",
        "content_type_value": "string",
    },
    force_nonce_check=False,
    http_vpc_service_config={
        "method": "string",
        "name": "string",
        "path": "string",
        "timeout": 0,
        "aone_name": "string",
        "content_type_category": "string",
        "content_type_value": "string",
        "vpc_scheme": "string",
    },
    mock_service_config={
        "result": "string",
        "aone_name": "string",
    },
    name="string",
    fc_service_config={
        "arn_role": "string",
        "region": "string",
        "timeout": 0,
        "function_base_url": "string",
        "function_name": "string",
        "function_type": "string",
        "method": "string",
        "only_business_path": False,
        "path": "string",
        "qualifier": "string",
        "service_name": "string",
    },
    request_parameters=[{
        "in_": "string",
        "in_service": "string",
        "name": "string",
        "name_service": "string",
        "required": "string",
        "type": "string",
        "default_value": "string",
        "description": "string",
    }],
    constant_parameters=[{
        "in_": "string",
        "name": "string",
        "value": "string",
        "description": "string",
    }],
    stage_names=["string"],
    system_parameters=[{
        "in_": "string",
        "name": "string",
        "name_service": "string",
    }])

const apiResource = new alicloud.apigateway.Api("apiResource", {
    groupId: "string",
    serviceType: "string",
    description: "string",
    requestConfig: {
        method: "string",
        mode: "string",
        path: "string",
        protocol: "string",
        bodyFormat: "string",
    },
    authType: "string",
    httpServiceConfig: {
        address: "string",
        method: "string",
        path: "string",
        timeout: 0,
        aoneName: "string",
        contentTypeCategory: "string",
        contentTypeValue: "string",
    },
    forceNonceCheck: false,
    httpVpcServiceConfig: {
        method: "string",
        name: "string",
        path: "string",
        timeout: 0,
        aoneName: "string",
        contentTypeCategory: "string",
        contentTypeValue: "string",
        vpcScheme: "string",
    },
    mockServiceConfig: {
        result: "string",
        aoneName: "string",
    },
    name: "string",
    fcServiceConfig: {
        arnRole: "string",
        region: "string",
        timeout: 0,
        functionBaseUrl: "string",
        functionName: "string",
        functionType: "string",
        method: "string",
        onlyBusinessPath: false,
        path: "string",
        qualifier: "string",
        serviceName: "string",
    },
    requestParameters: [{
        "in": "string",
        inService: "string",
        name: "string",
        nameService: "string",
        required: "string",
        type: "string",
        defaultValue: "string",
        description: "string",
    }],
    constantParameters: [{
        "in": "string",
        name: "string",
        value: "string",
        description: "string",
    }],
    stageNames: ["string"],
    systemParameters: [{
        "in": "string",
        name: "string",
        nameService: "string",
    }],
});

type: alicloud:apigateway:Api
properties:
    authType: string
    constantParameters:
        - description: string
          in: string
          name: string
          value: string
    description: string
    fcServiceConfig:
        arnRole: string
        functionBaseUrl: string
        functionName: string
        functionType: string
        method: string
        onlyBusinessPath: false
        path: string
        qualifier: string
        region: string
        serviceName: string
        timeout: 0
    forceNonceCheck: false
    groupId: string
    httpServiceConfig:
        address: string
        aoneName: string
        contentTypeCategory: string
        contentTypeValue: string
        method: string
        path: string
        timeout: 0
    httpVpcServiceConfig:
        aoneName: string
        contentTypeCategory: string
        contentTypeValue: string
        method: string
        name: string
        path: string
        timeout: 0
        vpcScheme: string
    mockServiceConfig:
        aoneName: string
        result: string
    name: string
    requestConfig:
        bodyFormat: string
        method: string
        mode: string
        path: string
        protocol: string
    requestParameters:
        - defaultValue: string
          description: string
          in: string
          inService: string
          name: string
          nameService: string
          required: string
          type: string
    serviceType: string
    stageNames:
        - string
    systemParameters:
        - in: string
          name: string
          nameService: string

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

AuthType string: The authorization Type including APP and ANONYMOUS. Defaults to null.
Description string: The description of the api. Defaults to null.
GroupId string: The api gateway that the api belongs to. Defaults to null.
RequestConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestConfig: Request_config defines how users can send requests to your API. See request_config below.
ServiceType string: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
ConstantParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiConstantParameter>: constant_parameters defines the constant parameters of the api. See constant_parameters below.
FcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiFcServiceConfig: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
ForceNonceCheck bool: Whether to prevent API replay attack. Default value: false.
HttpServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpServiceConfig: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
HttpVpcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpVpcServiceConfig: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
MockServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiMockServiceConfig: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
Name string: The name of the api gateway api. Defaults to null.
RequestParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestParameter>: request_parameters defines the request parameters of the api. See request_parameters below.
StageNames List<string>: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
SystemParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiSystemParameter>: system_parameters defines the system parameters of the api. See system_parameters below.

AuthType string: The authorization Type including APP and ANONYMOUS. Defaults to null.
Description string: The description of the api. Defaults to null.
GroupId string: The api gateway that the api belongs to. Defaults to null.
RequestConfig ApiRequestConfigArgs: Request_config defines how users can send requests to your API. See request_config below.
ServiceType string: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
ConstantParameters []ApiConstantParameterArgs: constant_parameters defines the constant parameters of the api. See constant_parameters below.
FcServiceConfig ApiFcServiceConfigArgs: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
ForceNonceCheck bool: Whether to prevent API replay attack. Default value: false.
HttpServiceConfig ApiHttpServiceConfigArgs: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
HttpVpcServiceConfig ApiHttpVpcServiceConfigArgs: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
MockServiceConfig ApiMockServiceConfigArgs: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
Name string: The name of the api gateway api. Defaults to null.
RequestParameters []ApiRequestParameterArgs: request_parameters defines the request parameters of the api. See request_parameters below.
StageNames []string: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
SystemParameters []ApiSystemParameterArgs: system_parameters defines the system parameters of the api. See system_parameters below.

authType String: The authorization Type including APP and ANONYMOUS. Defaults to null.
description String: The description of the api. Defaults to null.
groupId String: The api gateway that the api belongs to. Defaults to null.
requestConfig ApiRequestConfig: Request_config defines how users can send requests to your API. See request_config below.
serviceType String: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
constantParameters List<ApiConstantParameter>: constant_parameters defines the constant parameters of the api. See constant_parameters below.
fcServiceConfig ApiFcServiceConfig: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
forceNonceCheck Boolean: Whether to prevent API replay attack. Default value: false.
httpServiceConfig ApiHttpServiceConfig: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
httpVpcServiceConfig ApiHttpVpcServiceConfig: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mockServiceConfig ApiMockServiceConfig: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name String: The name of the api gateway api. Defaults to null.
requestParameters List<ApiRequestParameter>: request_parameters defines the request parameters of the api. See request_parameters below.
stageNames List<String>: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
systemParameters List<ApiSystemParameter>: system_parameters defines the system parameters of the api. See system_parameters below.

authType string: The authorization Type including APP and ANONYMOUS. Defaults to null.
description string: The description of the api. Defaults to null.
groupId string: The api gateway that the api belongs to. Defaults to null.
requestConfig ApiRequestConfig: Request_config defines how users can send requests to your API. See request_config below.
serviceType string: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
constantParameters ApiConstantParameter[]: constant_parameters defines the constant parameters of the api. See constant_parameters below.
fcServiceConfig ApiFcServiceConfig: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
forceNonceCheck boolean: Whether to prevent API replay attack. Default value: false.
httpServiceConfig ApiHttpServiceConfig: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
httpVpcServiceConfig ApiHttpVpcServiceConfig: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mockServiceConfig ApiMockServiceConfig: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name string: The name of the api gateway api. Defaults to null.
requestParameters ApiRequestParameter[]: request_parameters defines the request parameters of the api. See request_parameters below.
stageNames string[]: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
systemParameters ApiSystemParameter[]: system_parameters defines the system parameters of the api. See system_parameters below.

auth_type str: The authorization Type including APP and ANONYMOUS. Defaults to null.
description str: The description of the api. Defaults to null.
group_id str: The api gateway that the api belongs to. Defaults to null.
request_config ApiRequestConfigArgs: Request_config defines how users can send requests to your API. See request_config below.
service_type str: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
constant_parameters Sequence[ApiConstantParameterArgs]: constant_parameters defines the constant parameters of the api. See constant_parameters below.
fc_service_config ApiFcServiceConfigArgs: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
force_nonce_check bool: Whether to prevent API replay attack. Default value: false.
http_service_config ApiHttpServiceConfigArgs: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
http_vpc_service_config ApiHttpVpcServiceConfigArgs: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mock_service_config ApiMockServiceConfigArgs: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name str: The name of the api gateway api. Defaults to null.
request_parameters Sequence[ApiRequestParameterArgs]: request_parameters defines the request parameters of the api. See request_parameters below.
stage_names Sequence[str]: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
system_parameters Sequence[ApiSystemParameterArgs]: system_parameters defines the system parameters of the api. See system_parameters below.

authType String: The authorization Type including APP and ANONYMOUS. Defaults to null.
description String: The description of the api. Defaults to null.
groupId String: The api gateway that the api belongs to. Defaults to null.
requestConfig Property Map: Request_config defines how users can send requests to your API. See request_config below.
serviceType String: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
constantParameters List<Property Map>: constant_parameters defines the constant parameters of the api. See constant_parameters below.
fcServiceConfig Property Map: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
forceNonceCheck Boolean: Whether to prevent API replay attack. Default value: false.
httpServiceConfig Property Map: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
httpVpcServiceConfig Property Map: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mockServiceConfig Property Map: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name String: The name of the api gateway api. Defaults to null.
requestParameters List<Property Map>: request_parameters defines the request parameters of the api. See request_parameters below.
stageNames List<String>: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
systemParameters List<Property Map>: system_parameters defines the system parameters of the api. See system_parameters below.

Outputs

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

ApiId string: The ID of the api of api gateway.
Id string: The provider-assigned unique ID for this managed resource.

ApiId string: The ID of the api of api gateway.
Id string: The provider-assigned unique ID for this managed resource.

apiId String: The ID of the api of api gateway.
id String: The provider-assigned unique ID for this managed resource.

apiId string: The ID of the api of api gateway.
id string: The provider-assigned unique ID for this managed resource.

api_id str: The ID of the api of api gateway.
id str: The provider-assigned unique ID for this managed resource.

apiId String: The ID of the api of api gateway.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Api Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: ApiState, opts?: CustomResourceOptions): Api

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        auth_type: Optional[str] = None,
        constant_parameters: Optional[Sequence[ApiConstantParameterArgs]] = None,
        description: Optional[str] = None,
        fc_service_config: Optional[ApiFcServiceConfigArgs] = None,
        force_nonce_check: Optional[bool] = None,
        group_id: Optional[str] = None,
        http_service_config: Optional[ApiHttpServiceConfigArgs] = None,
        http_vpc_service_config: Optional[ApiHttpVpcServiceConfigArgs] = None,
        mock_service_config: Optional[ApiMockServiceConfigArgs] = None,
        name: Optional[str] = None,
        request_config: Optional[ApiRequestConfigArgs] = None,
        request_parameters: Optional[Sequence[ApiRequestParameterArgs]] = None,
        service_type: Optional[str] = None,
        stage_names: Optional[Sequence[str]] = None,
        system_parameters: Optional[Sequence[ApiSystemParameterArgs]] = None) -> Api

func GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)

public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)

public static Api get(String name, Output<String> id, ApiState state, CustomResourceOptions options)

resources:  _:    type: alicloud:apigateway:Api    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:

ApiId string: The ID of the api of api gateway.
AuthType string: The authorization Type including APP and ANONYMOUS. Defaults to null.
ConstantParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiConstantParameter>: constant_parameters defines the constant parameters of the api. See constant_parameters below.
Description string: The description of the api. Defaults to null.
FcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiFcServiceConfig: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
ForceNonceCheck bool: Whether to prevent API replay attack. Default value: false.
GroupId string: The api gateway that the api belongs to. Defaults to null.
HttpServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpServiceConfig: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
HttpVpcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpVpcServiceConfig: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
MockServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiMockServiceConfig: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
Name string: The name of the api gateway api. Defaults to null.
RequestConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestConfig: Request_config defines how users can send requests to your API. See request_config below.
RequestParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestParameter>: request_parameters defines the request parameters of the api. See request_parameters below.
ServiceType string: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
StageNames List<string>: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
SystemParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiSystemParameter>: system_parameters defines the system parameters of the api. See system_parameters below.

ApiId string: The ID of the api of api gateway.
AuthType string: The authorization Type including APP and ANONYMOUS. Defaults to null.
ConstantParameters []ApiConstantParameterArgs: constant_parameters defines the constant parameters of the api. See constant_parameters below.
Description string: The description of the api. Defaults to null.
FcServiceConfig ApiFcServiceConfigArgs: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
ForceNonceCheck bool: Whether to prevent API replay attack. Default value: false.
GroupId string: The api gateway that the api belongs to. Defaults to null.
HttpServiceConfig ApiHttpServiceConfigArgs: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
HttpVpcServiceConfig ApiHttpVpcServiceConfigArgs: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
MockServiceConfig ApiMockServiceConfigArgs: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
Name string: The name of the api gateway api. Defaults to null.
RequestConfig ApiRequestConfigArgs: Request_config defines how users can send requests to your API. See request_config below.
RequestParameters []ApiRequestParameterArgs: request_parameters defines the request parameters of the api. See request_parameters below.
ServiceType string: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
StageNames []string: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
SystemParameters []ApiSystemParameterArgs: system_parameters defines the system parameters of the api. See system_parameters below.

apiId String: The ID of the api of api gateway.
authType String: The authorization Type including APP and ANONYMOUS. Defaults to null.
constantParameters List<ApiConstantParameter>: constant_parameters defines the constant parameters of the api. See constant_parameters below.
description String: The description of the api. Defaults to null.
fcServiceConfig ApiFcServiceConfig: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
forceNonceCheck Boolean: Whether to prevent API replay attack. Default value: false.
groupId String: The api gateway that the api belongs to. Defaults to null.
httpServiceConfig ApiHttpServiceConfig: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
httpVpcServiceConfig ApiHttpVpcServiceConfig: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mockServiceConfig ApiMockServiceConfig: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name String: The name of the api gateway api. Defaults to null.
requestConfig ApiRequestConfig: Request_config defines how users can send requests to your API. See request_config below.
requestParameters List<ApiRequestParameter>: request_parameters defines the request parameters of the api. See request_parameters below.
serviceType String: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
stageNames List<String>: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
systemParameters List<ApiSystemParameter>: system_parameters defines the system parameters of the api. See system_parameters below.

apiId string: The ID of the api of api gateway.
authType string: The authorization Type including APP and ANONYMOUS. Defaults to null.
constantParameters ApiConstantParameter[]: constant_parameters defines the constant parameters of the api. See constant_parameters below.
description string: The description of the api. Defaults to null.
fcServiceConfig ApiFcServiceConfig: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
forceNonceCheck boolean: Whether to prevent API replay attack. Default value: false.
groupId string: The api gateway that the api belongs to. Defaults to null.
httpServiceConfig ApiHttpServiceConfig: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
httpVpcServiceConfig ApiHttpVpcServiceConfig: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mockServiceConfig ApiMockServiceConfig: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name string: The name of the api gateway api. Defaults to null.
requestConfig ApiRequestConfig: Request_config defines how users can send requests to your API. See request_config below.
requestParameters ApiRequestParameter[]: request_parameters defines the request parameters of the api. See request_parameters below.
serviceType string: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
stageNames string[]: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
systemParameters ApiSystemParameter[]: system_parameters defines the system parameters of the api. See system_parameters below.

api_id str: The ID of the api of api gateway.
auth_type str: The authorization Type including APP and ANONYMOUS. Defaults to null.
constant_parameters Sequence[ApiConstantParameterArgs]: constant_parameters defines the constant parameters of the api. See constant_parameters below.
description str: The description of the api. Defaults to null.
fc_service_config ApiFcServiceConfigArgs: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
force_nonce_check bool: Whether to prevent API replay attack. Default value: false.
group_id str: The api gateway that the api belongs to. Defaults to null.
http_service_config ApiHttpServiceConfigArgs: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
http_vpc_service_config ApiHttpVpcServiceConfigArgs: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mock_service_config ApiMockServiceConfigArgs: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name str: The name of the api gateway api. Defaults to null.
request_config ApiRequestConfigArgs: Request_config defines how users can send requests to your API. See request_config below.
request_parameters Sequence[ApiRequestParameterArgs]: request_parameters defines the request parameters of the api. See request_parameters below.
service_type str: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
stage_names Sequence[str]: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
system_parameters Sequence[ApiSystemParameterArgs]: system_parameters defines the system parameters of the api. See system_parameters below.

apiId String: The ID of the api of api gateway.
authType String: The authorization Type including APP and ANONYMOUS. Defaults to null.
constantParameters List<Property Map>: constant_parameters defines the constant parameters of the api. See constant_parameters below.
description String: The description of the api. Defaults to null.
fcServiceConfig Property Map: fc_service_config defines the config when service_type selected 'FunctionCompute'. See fc_service_config below.
forceNonceCheck Boolean: Whether to prevent API replay attack. Default value: false.
groupId String: The api gateway that the api belongs to. Defaults to null.
httpServiceConfig Property Map: http_service_config defines the config when service_type selected 'HTTP'. See http_service_config below.
httpVpcServiceConfig Property Map: http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'. See http_vpc_service_config below.
mockServiceConfig Property Map: http_service_config defines the config when service_type selected 'MOCK'. See mock_service_config below.
name String: The name of the api gateway api. Defaults to null.
requestConfig Property Map: Request_config defines how users can send requests to your API. See request_config below.
requestParameters List<Property Map>: request_parameters defines the request parameters of the api. See request_parameters below.
serviceType String: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
stageNames List<String>: Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.
systemParameters List<Property Map>: system_parameters defines the system parameters of the api. See system_parameters below.

Supporting Types

ApiConstantParameter
, ApiConstantParameterArgs

In string: Constant parameter location; values: 'HEAD' and 'QUERY'.
Name string: Constant parameter name.
Value string: Constant parameter value.
Description string: The description of Constant parameter.

In string: Constant parameter location; values: 'HEAD' and 'QUERY'.
Name string: Constant parameter name.
Value string: Constant parameter value.
Description string: The description of Constant parameter.

in String: Constant parameter location; values: 'HEAD' and 'QUERY'.
name String: Constant parameter name.
value String: Constant parameter value.
description String: The description of Constant parameter.

in string: Constant parameter location; values: 'HEAD' and 'QUERY'.
name string: Constant parameter name.
value string: Constant parameter value.
description string: The description of Constant parameter.

in_ str: Constant parameter location; values: 'HEAD' and 'QUERY'.
name str: Constant parameter name.
value str: Constant parameter value.
description str: The description of Constant parameter.

in String: Constant parameter location; values: 'HEAD' and 'QUERY'.
name String: Constant parameter name.
value String: Constant parameter value.
description String: The description of Constant parameter.

ApiFcServiceConfig
, ApiFcServiceConfigArgs

ArnRole string: RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
Region string: The region that the function compute service belongs to.
Timeout int: Backend service time-out time; unit: millisecond.
FunctionBaseUrl string: The base url of function compute service. Required if function_type is HttpTrigger.
FunctionName string: The function name of function compute service. Required if function_type is FCEvent.
FunctionType string: The type of function compute service. Supports values of FCEvent,HttpTrigger. Default value: FCEvent.
Method string: The http method of function compute service. Required if function_type is HttpTrigger.
OnlyBusinessPath bool: Whether to filter path in function_base_url. Optional if function_type is HttpTrigger.
Path string: The path of function compute service. Required if function_type is HttpTrigger.
Qualifier string: The qualifier of function name of compute service.
ServiceName string: The service name of function compute service. Required if function_type is FCEvent.

ArnRole string: RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
Region string: The region that the function compute service belongs to.
Timeout int: Backend service time-out time; unit: millisecond.
FunctionBaseUrl string: The base url of function compute service. Required if function_type is HttpTrigger.
FunctionName string: The function name of function compute service. Required if function_type is FCEvent.
FunctionType string: The type of function compute service. Supports values of FCEvent,HttpTrigger. Default value: FCEvent.
Method string: The http method of function compute service. Required if function_type is HttpTrigger.
OnlyBusinessPath bool: Whether to filter path in function_base_url. Optional if function_type is HttpTrigger.
Path string: The path of function compute service. Required if function_type is HttpTrigger.
Qualifier string: The qualifier of function name of compute service.
ServiceName string: The service name of function compute service. Required if function_type is FCEvent.

arnRole String: RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
region String: The region that the function compute service belongs to.
timeout Integer: Backend service time-out time; unit: millisecond.
functionBaseUrl String: The base url of function compute service. Required if function_type is HttpTrigger.
functionName String: The function name of function compute service. Required if function_type is FCEvent.
functionType String: The type of function compute service. Supports values of FCEvent,HttpTrigger. Default value: FCEvent.
method String: The http method of function compute service. Required if function_type is HttpTrigger.
onlyBusinessPath Boolean: Whether to filter path in function_base_url. Optional if function_type is HttpTrigger.
path String: The path of function compute service. Required if function_type is HttpTrigger.
qualifier String: The qualifier of function name of compute service.
serviceName String: The service name of function compute service. Required if function_type is FCEvent.

arnRole string: RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
region string: The region that the function compute service belongs to.
timeout number: Backend service time-out time; unit: millisecond.
functionBaseUrl string: The base url of function compute service. Required if function_type is HttpTrigger.
functionName string: The function name of function compute service. Required if function_type is FCEvent.
functionType string: The type of function compute service. Supports values of FCEvent,HttpTrigger. Default value: FCEvent.
method string: The http method of function compute service. Required if function_type is HttpTrigger.
onlyBusinessPath boolean: Whether to filter path in function_base_url. Optional if function_type is HttpTrigger.
path string: The path of function compute service. Required if function_type is HttpTrigger.
qualifier string: The qualifier of function name of compute service.
serviceName string: The service name of function compute service. Required if function_type is FCEvent.

arn_role str: RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
region str: The region that the function compute service belongs to.
timeout int: Backend service time-out time; unit: millisecond.
function_base_url str: The base url of function compute service. Required if function_type is HttpTrigger.
function_name str: The function name of function compute service. Required if function_type is FCEvent.
function_type str: The type of function compute service. Supports values of FCEvent,HttpTrigger. Default value: FCEvent.
method str: The http method of function compute service. Required if function_type is HttpTrigger.
only_business_path bool: Whether to filter path in function_base_url. Optional if function_type is HttpTrigger.
path str: The path of function compute service. Required if function_type is HttpTrigger.
qualifier str: The qualifier of function name of compute service.
service_name str: The service name of function compute service. Required if function_type is FCEvent.

arnRole String: RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
region String: The region that the function compute service belongs to.
timeout Number: Backend service time-out time; unit: millisecond.
functionBaseUrl String: The base url of function compute service. Required if function_type is HttpTrigger.
functionName String: The function name of function compute service. Required if function_type is FCEvent.
functionType String: The type of function compute service. Supports values of FCEvent,HttpTrigger. Default value: FCEvent.
method String: The http method of function compute service. Required if function_type is HttpTrigger.
onlyBusinessPath Boolean: Whether to filter path in function_base_url. Optional if function_type is HttpTrigger.
path String: The path of function compute service. Required if function_type is HttpTrigger.
qualifier String: The qualifier of function name of compute service.
serviceName String: The service name of function compute service. Required if function_type is FCEvent.

ApiHttpServiceConfig
, ApiHttpServiceConfigArgs

Address string: The address of backend service.
Method string: The http method of backend service.
Path string: The path of backend service.
Timeout int: Backend service time-out time; unit: millisecond.
AoneName string: The name of aone.
ContentTypeCategory string: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
ContentTypeValue string: The content type value of backend service.

Address string: The address of backend service.
Method string: The http method of backend service.
Path string: The path of backend service.
Timeout int: Backend service time-out time; unit: millisecond.
AoneName string: The name of aone.
ContentTypeCategory string: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
ContentTypeValue string: The content type value of backend service.

address String: The address of backend service.
method String: The http method of backend service.
path String: The path of backend service.
timeout Integer: Backend service time-out time; unit: millisecond.
aoneName String: The name of aone.
contentTypeCategory String: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
contentTypeValue String: The content type value of backend service.

address string: The address of backend service.
method string: The http method of backend service.
path string: The path of backend service.
timeout number: Backend service time-out time; unit: millisecond.
aoneName string: The name of aone.
contentTypeCategory string: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
contentTypeValue string: The content type value of backend service.

address str: The address of backend service.
method str: The http method of backend service.
path str: The path of backend service.
timeout int: Backend service time-out time; unit: millisecond.
aone_name str: The name of aone.
content_type_category str: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
content_type_value str: The content type value of backend service.

address String: The address of backend service.
method String: The http method of backend service.
path String: The path of backend service.
timeout Number: Backend service time-out time; unit: millisecond.
aoneName String: The name of aone.
contentTypeCategory String: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
contentTypeValue String: The content type value of backend service.

ApiHttpVpcServiceConfig
, ApiHttpVpcServiceConfigArgs

Method string: The http method of backend service.
Name string: The name of vpc instance.
Path string: The path of backend service.
Timeout int: Backend service time-out time. Unit: millisecond.
AoneName string: The name of aone.
ContentTypeCategory string: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
ContentTypeValue string: The content type value of backend service.
VpcScheme string: The vpc scheme of backend service which supports values of HTTP and HTTPS.

Method string: The http method of backend service.
Name string: The name of vpc instance.
Path string: The path of backend service.
Timeout int: Backend service time-out time. Unit: millisecond.
AoneName string: The name of aone.
ContentTypeCategory string: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
ContentTypeValue string: The content type value of backend service.
VpcScheme string: The vpc scheme of backend service which supports values of HTTP and HTTPS.

method String: The http method of backend service.
name String: The name of vpc instance.
path String: The path of backend service.
timeout Integer: Backend service time-out time. Unit: millisecond.
aoneName String: The name of aone.
contentTypeCategory String: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
contentTypeValue String: The content type value of backend service.
vpcScheme String: The vpc scheme of backend service which supports values of HTTP and HTTPS.

method string: The http method of backend service.
name string: The name of vpc instance.
path string: The path of backend service.
timeout number: Backend service time-out time. Unit: millisecond.
aoneName string: The name of aone.
contentTypeCategory string: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
contentTypeValue string: The content type value of backend service.
vpcScheme string: The vpc scheme of backend service which supports values of HTTP and HTTPS.

method str: The http method of backend service.
name str: The name of vpc instance.
path str: The path of backend service.
timeout int: Backend service time-out time. Unit: millisecond.
aone_name str: The name of aone.
content_type_category str: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
content_type_value str: The content type value of backend service.
vpc_scheme str: The vpc scheme of backend service which supports values of HTTP and HTTPS.

method String: The http method of backend service.
name String: The name of vpc instance.
path String: The path of backend service.
timeout Number: Backend service time-out time. Unit: millisecond.
aoneName String: The name of aone.
contentTypeCategory String: The content type category of backend service which supports values of 'DEFAULT','CUSTOM' and 'CLIENT'.
contentTypeValue String: The content type value of backend service.
vpcScheme String: The vpc scheme of backend service which supports values of HTTP and HTTPS.

ApiMockServiceConfig
, ApiMockServiceConfigArgs

Result string: The result of the mock service.
AoneName string: The name of aone.

Result string: The result of the mock service.
AoneName string: The name of aone.

result String: The result of the mock service.
aoneName String: The name of aone.

result string: The result of the mock service.
aoneName string: The name of aone.

result str: The result of the mock service.
aone_name str: The name of aone.

result String: The result of the mock service.
aoneName String: The name of aone.

ApiRequestConfig
, ApiRequestConfigArgs

Method string: The method of the api, including 'GET','POST','PUT' etc.
Mode string: The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.
Path string: The request path of the api.
Protocol string: The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.
BodyFormat string: The body format of the api, which support the values of 'STREAM' and 'FORM'.

Method string: The method of the api, including 'GET','POST','PUT' etc.
Mode string: The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.
Path string: The request path of the api.
Protocol string: The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.
BodyFormat string: The body format of the api, which support the values of 'STREAM' and 'FORM'.

method String: The method of the api, including 'GET','POST','PUT' etc.
mode String: The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.
path String: The request path of the api.
protocol String: The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.
bodyFormat String: The body format of the api, which support the values of 'STREAM' and 'FORM'.

method string: The method of the api, including 'GET','POST','PUT' etc.
mode string: The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.
path string: The request path of the api.
protocol string: The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.
bodyFormat string: The body format of the api, which support the values of 'STREAM' and 'FORM'.

method str: The method of the api, including 'GET','POST','PUT' etc.
mode str: The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.
path str: The request path of the api.
protocol str: The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.
body_format str: The body format of the api, which support the values of 'STREAM' and 'FORM'.

method String: The method of the api, including 'GET','POST','PUT' etc.
mode String: The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.
path String: The request path of the api.
protocol String: The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.
bodyFormat String: The body format of the api, which support the values of 'STREAM' and 'FORM'.

ApiRequestParameter
, ApiRequestParameterArgs

In string: Request's parameter location; values: BODY, HEAD, QUERY, and PATH.
InService string: Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.
Name string: Request's parameter name.
NameService string: Backend service's parameter name.
Required string: Parameter required or not; values: REQUIRED and OPTIONAL.
Type string: Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".
DefaultValue string: The default value of the parameter.
Description string: The description of parameter.

In string: Request's parameter location; values: BODY, HEAD, QUERY, and PATH.
InService string: Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.
Name string: Request's parameter name.
NameService string: Backend service's parameter name.
Required string: Parameter required or not; values: REQUIRED and OPTIONAL.
Type string: Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".
DefaultValue string: The default value of the parameter.
Description string: The description of parameter.

in String: Request's parameter location; values: BODY, HEAD, QUERY, and PATH.
inService String: Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.
name String: Request's parameter name.
nameService String: Backend service's parameter name.
required String: Parameter required or not; values: REQUIRED and OPTIONAL.
type String: Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".
defaultValue String: The default value of the parameter.
description String: The description of parameter.

in string: Request's parameter location; values: BODY, HEAD, QUERY, and PATH.
inService string: Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.
name string: Request's parameter name.
nameService string: Backend service's parameter name.
required string: Parameter required or not; values: REQUIRED and OPTIONAL.
type string: Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".
defaultValue string: The default value of the parameter.
description string: The description of parameter.

in_ str: Request's parameter location; values: BODY, HEAD, QUERY, and PATH.
in_service str: Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.
name str: Request's parameter name.
name_service str: Backend service's parameter name.
required str: Parameter required or not; values: REQUIRED and OPTIONAL.
type str: Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".
default_value str: The default value of the parameter.
description str: The description of parameter.

in String: Request's parameter location; values: BODY, HEAD, QUERY, and PATH.
inService String: Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.
name String: Request's parameter name.
nameService String: Backend service's parameter name.
required String: Parameter required or not; values: REQUIRED and OPTIONAL.
type String: Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".
defaultValue String: The default value of the parameter.
description String: The description of parameter.

ApiSystemParameter
, ApiSystemParameterArgs

In string: System parameter location; values: 'HEAD' and 'QUERY'.
Name string: System parameter name which supports values including in system parameter list.
NameService string: Backend service's parameter name.

In string: System parameter location; values: 'HEAD' and 'QUERY'.
Name string: System parameter name which supports values including in system parameter list.
NameService string: Backend service's parameter name.

in String: System parameter location; values: 'HEAD' and 'QUERY'.
name String: System parameter name which supports values including in system parameter list.
nameService String: Backend service's parameter name.

in string: System parameter location; values: 'HEAD' and 'QUERY'.
name string: System parameter name which supports values including in system parameter list.
nameService string: Backend service's parameter name.

in_ str: System parameter location; values: 'HEAD' and 'QUERY'.
name str: System parameter name which supports values including in system parameter list.
name_service str: Backend service's parameter name.

in String: System parameter location; values: 'HEAD' and 'QUERY'.
name String: System parameter name which supports values including in system parameter list.
nameService String: Backend service's parameter name.

Import

Api gateway api can be imported using the id.Format to <API Group Id>:<API Id> e.g.

$ pulumi import alicloud:apigateway/api:Api example "ab2351f2ce904edaa8d92a0510832b91:e4f728fca5a94148b023b99a3e5d0b62"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.apigateway.Api

On this page

On this page

Example Usage

Create Api Resource

Constructor syntax

Parameters

Constructor example

Api Resource Properties

Inputs

Outputs

Look up Existing Api Resource

Supporting Types

ApiConstantParameter
, ApiConstantParameterArgs

ApiFcServiceConfig
, ApiFcServiceConfigArgs

ApiHttpServiceConfig
, ApiHttpServiceConfigArgs

ApiHttpVpcServiceConfig
, ApiHttpVpcServiceConfigArgs

ApiMockServiceConfig
, ApiMockServiceConfigArgs

ApiRequestConfig
, ApiRequestConfigArgs

ApiRequestParameter
, ApiRequestParameterArgs

ApiSystemParameter
, ApiSystemParameterArgs

Import

Package Details

On this page

On this page

alicloud.apigateway.Api

On this page

On this page

Example Usage

Create Api Resource

Constructor syntax

Parameters

Constructor example

Api Resource Properties

Inputs

Outputs

Look up Existing Api Resource

Supporting Types

ApiConstantParameter, ApiConstantParameterArgs

ApiFcServiceConfig, ApiFcServiceConfigArgs

ApiHttpServiceConfig, ApiHttpServiceConfigArgs

ApiHttpVpcServiceConfig, ApiHttpVpcServiceConfigArgs

ApiMockServiceConfig, ApiMockServiceConfigArgs

ApiRequestConfig, ApiRequestConfigArgs

ApiRequestParameter, ApiRequestParameterArgs

ApiSystemParameter, ApiSystemParameterArgs

Import

Package Details

On this page

On this page

ApiConstantParameter
, ApiConstantParameterArgs

ApiFcServiceConfig
, ApiFcServiceConfigArgs

ApiHttpServiceConfig
, ApiHttpServiceConfigArgs

ApiHttpVpcServiceConfig
, ApiHttpVpcServiceConfigArgs

ApiMockServiceConfig
, ApiMockServiceConfigArgs

ApiRequestConfig
, ApiRequestConfigArgs

ApiRequestParameter
, ApiRequestParameterArgs

ApiSystemParameter
, ApiSystemParameterArgs