published on Monday, Aug 24, 2026 by Pulumi
published on Monday, Aug 24, 2026 by Pulumi
Provides a APIG Http Api resource.
For information about APIG Http Api and how to use it, see What is Http Api.
NOTE: Available since v1.240.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const protocol = config.get("protocol") || "HTTP";
const protocolHttps = config.get("protocolHttps") || "HTTPS";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultHttpApi = new alicloud.apig.HttpApi("default", {
httpApiName: name,
protocols: [protocol],
basePath: "/v1",
description: "zhiwei_pop_examplecase",
type: "Rest",
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
protocol = config.get("protocol")
if protocol is None:
protocol = "HTTP"
protocol_https = config.get("protocolHttps")
if protocol_https is None:
protocol_https = "HTTPS"
default = alicloud.resourcemanager.get_resource_groups()
default_http_api = alicloud.apig.HttpApi("default",
http_api_name=name,
protocols=[protocol],
base_path="/v1",
description="zhiwei_pop_examplecase",
type="Rest")
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apig"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
protocol := "HTTP"
if param := cfg.Get("protocol"); param != "" {
protocol = param
}
protocolHttps := "HTTPS"
if param := cfg.Get("protocolHttps"); param != "" {
protocolHttps = param
}
_, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
if err != nil {
return err
}
_, err = apig.NewHttpApi(ctx, "default", &apig.HttpApiArgs{
HttpApiName: pulumi.String(name),
Protocols: pulumi.StringArray{
pulumi.String(protocol),
},
BasePath: pulumi.String("/v1"),
Description: pulumi.String("zhiwei_pop_examplecase"),
Type: pulumi.String("Rest"),
})
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 config = new Config();
var name = config.Get("name") ?? "terraform-example";
var protocol = config.Get("protocol") ?? "HTTP";
var protocolHttps = config.Get("protocolHttps") ?? "HTTPS";
var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();
var defaultHttpApi = new AliCloud.Apig.HttpApi("default", new()
{
HttpApiName = name,
Protocols = new[]
{
protocol,
},
BasePath = "/v1",
Description = "zhiwei_pop_examplecase",
Type = "Rest",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.apig.HttpApi;
import com.pulumi.alicloud.apig.HttpApiArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("terraform-example");
final var protocol = config.get("protocol").orElse("HTTP");
final var protocolHttps = config.get("protocolHttps").orElse("HTTPS");
final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
.build());
var defaultHttpApi = new HttpApi("defaultHttpApi", HttpApiArgs.builder()
.httpApiName(name)
.protocols(protocol)
.basePath("/v1")
.description("zhiwei_pop_examplecase")
.type("Rest")
.build());
}
}
configuration:
name:
type: string
default: terraform-example
protocol:
type: string
default: HTTP
protocolHttps:
type: string
default: HTTPS
resources:
defaultHttpApi:
type: alicloud:apig:HttpApi
name: default
properties:
httpApiName: ${name}
protocols:
- ${protocol}
basePath: /v1
description: zhiwei_pop_examplecase
type: Rest
variables:
default:
fn::invoke:
function: alicloud:resourcemanager:getResourceGroups
arguments: {}
pulumi {
required_providers {
alicloud = {
source = "pulumi/alicloud"
}
}
}
data "alicloud_resourcemanager_getresourcegroups" "default" {
}
resource "alicloud_apig_httpapi" "default" {
http_api_name = var.name
protocols = [var.protocol]
base_path = "/v1"
description = "zhiwei_pop_examplecase"
type = "Rest"
}
variable "name" {
type = string
default = "terraform-example"
}
variable "protocol" {
type = string
default = "HTTP"
}
variable "protocolHttps" {
type = string
default = "HTTPS"
}
📚 Need more examples? VIEW MORE EXAMPLES
Create HttpApi Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HttpApi(name: string, args: HttpApiArgs, opts?: CustomResourceOptions);@overload
def HttpApi(resource_name: str,
args: HttpApiArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HttpApi(resource_name: str,
opts: Optional[ResourceOptions] = None,
http_api_name: Optional[str] = None,
protocols: Optional[Sequence[str]] = None,
type: Optional[str] = None,
ai_protocols: Optional[Sequence[str]] = None,
base_path: Optional[str] = None,
deploy_configs: Optional[Sequence[str]] = None,
description: Optional[str] = None,
enable_auth: Optional[bool] = None,
model_category: Optional[str] = None,
resource_group_id: Optional[str] = None)func NewHttpApi(ctx *Context, name string, args HttpApiArgs, opts ...ResourceOption) (*HttpApi, error)public HttpApi(string name, HttpApiArgs args, CustomResourceOptions? opts = null)
public HttpApi(String name, HttpApiArgs args)
public HttpApi(String name, HttpApiArgs args, CustomResourceOptions options)
type: alicloud:apig:HttpApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "alicloud_apig_http_api" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args HttpApiArgs
- 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 HttpApiArgs
- 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 HttpApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HttpApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HttpApiArgs
- 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.
var httpApiResource = new AliCloud.Apig.HttpApi("httpApiResource", new()
{
HttpApiName = "string",
Protocols = new[]
{
"string",
},
Type = "string",
AiProtocols = new[]
{
"string",
},
BasePath = "string",
DeployConfigs = new[]
{
"string",
},
Description = "string",
EnableAuth = false,
ModelCategory = "string",
ResourceGroupId = "string",
});
example, err := apig.NewHttpApi(ctx, "httpApiResource", &apig.HttpApiArgs{
HttpApiName: pulumi.String("string"),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
AiProtocols: pulumi.StringArray{
pulumi.String("string"),
},
BasePath: pulumi.String("string"),
DeployConfigs: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
EnableAuth: pulumi.Bool(false),
ModelCategory: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
})
resource "alicloud_apig_http_api" "httpApiResource" {
lifecycle {
create_before_destroy = true
}
http_api_name = "string"
protocols = ["string"]
type = "string"
ai_protocols = ["string"]
base_path = "string"
deploy_configs = ["string"]
description = "string"
enable_auth = false
model_category = "string"
resource_group_id = "string"
}
var httpApiResource = new HttpApi("httpApiResource", HttpApiArgs.builder()
.httpApiName("string")
.protocols("string")
.type("string")
.aiProtocols("string")
.basePath("string")
.deployConfigs("string")
.description("string")
.enableAuth(false)
.modelCategory("string")
.resourceGroupId("string")
.build());
http_api_resource = alicloud.apig.HttpApi("httpApiResource",
http_api_name="string",
protocols=["string"],
type="string",
ai_protocols=["string"],
base_path="string",
deploy_configs=["string"],
description="string",
enable_auth=False,
model_category="string",
resource_group_id="string")
const httpApiResource = new alicloud.apig.HttpApi("httpApiResource", {
httpApiName: "string",
protocols: ["string"],
type: "string",
aiProtocols: ["string"],
basePath: "string",
deployConfigs: ["string"],
description: "string",
enableAuth: false,
modelCategory: "string",
resourceGroupId: "string",
});
type: alicloud:apig:HttpApi
properties:
aiProtocols:
- string
basePath: string
deployConfigs:
- string
description: string
enableAuth: false
httpApiName: string
modelCategory: string
protocols:
- string
resourceGroupId: string
type: string
HttpApi 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 HttpApi resource accepts the following input properties:
- Http
Api stringName - Perform an exact search by name.
- Protocols List<string>
- List of API access protocols. Valid values:
HTTP,HTTPS. - Type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- Ai
Protocols List<string> AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Base
Path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Deploy
Configs List<string> API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- Description string
- API description.
- Enable
Auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Model
Category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Resource
Group stringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- Http
Api stringName - Perform an exact search by name.
- Protocols []string
- List of API access protocols. Valid values:
HTTP,HTTPS. - Type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- Ai
Protocols []string AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Base
Path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Deploy
Configs []string API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- Description string
- API description.
- Enable
Auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Model
Category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Resource
Group stringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- http_
api_ stringname - Perform an exact search by name.
- protocols list(string)
- List of API access protocols. Valid values:
HTTP,HTTPS. - type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai_
protocols list(string) AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base_
path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy_
configs list(string) API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description string
- API description.
- enable_
auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- model_
category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- resource_
group_ stringid - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- http
Api StringName - Perform an exact search by name.
- protocols List<String>
- List of API access protocols. Valid values:
HTTP,HTTPS. - type String
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai
Protocols List<String> AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base
Path String API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy
Configs List<String> API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description String
- API description.
- enable
Auth Boolean Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- model
Category String AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- resource
Group StringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- http
Api stringName - Perform an exact search by name.
- protocols string[]
- List of API access protocols. Valid values:
HTTP,HTTPS. - type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai
Protocols string[] AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base
Path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy
Configs string[] API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description string
- API description.
- enable
Auth boolean Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- model
Category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- resource
Group stringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- http_
api_ strname - Perform an exact search by name.
- protocols Sequence[str]
- List of API access protocols. Valid values:
HTTP,HTTPS. - type str
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai_
protocols Sequence[str] AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base_
path str API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy_
configs Sequence[str] API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description str
- API description.
- enable_
auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- model_
category str AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- resource_
group_ strid - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- http
Api StringName - Perform an exact search by name.
- protocols List<String>
- List of API access protocols. Valid values:
HTTP,HTTPS. - type String
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai
Protocols List<String> AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base
Path String API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy
Configs List<String> API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description String
- API description.
- enable
Auth Boolean Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- model
Category String AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- resource
Group StringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
Outputs
All input properties are implicitly available as output properties. Additionally, the HttpApi resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing HttpApi Resource
Get an existing HttpApi 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?: HttpApiState, opts?: CustomResourceOptions): HttpApi@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
ai_protocols: Optional[Sequence[str]] = None,
base_path: Optional[str] = None,
deploy_configs: Optional[Sequence[str]] = None,
description: Optional[str] = None,
enable_auth: Optional[bool] = None,
http_api_name: Optional[str] = None,
model_category: Optional[str] = None,
protocols: Optional[Sequence[str]] = None,
resource_group_id: Optional[str] = None,
type: Optional[str] = None) -> HttpApifunc GetHttpApi(ctx *Context, name string, id IDInput, state *HttpApiState, opts ...ResourceOption) (*HttpApi, error)public static HttpApi Get(string name, Input<string> id, HttpApiState? state, CustomResourceOptions? opts = null)public static HttpApi get(String name, Output<String> id, HttpApiState state, CustomResourceOptions options)resources: _: type: alicloud:apig:HttpApi get: id: ${id}import {
to = alicloud_apig_http_api.example
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.
- Ai
Protocols List<string> AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Base
Path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Deploy
Configs List<string> API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- Description string
- API description.
- Enable
Auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Http
Api stringName - Perform an exact search by name.
- Model
Category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Protocols List<string>
- List of API access protocols. Valid values:
HTTP,HTTPS. - Resource
Group stringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- Type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- Ai
Protocols []string AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Base
Path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Deploy
Configs []string API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- Description string
- API description.
- Enable
Auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Http
Api stringName - Perform an exact search by name.
- Model
Category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- Protocols []string
- List of API access protocols. Valid values:
HTTP,HTTPS. - Resource
Group stringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- Type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai_
protocols list(string) AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base_
path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy_
configs list(string) API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description string
- API description.
- enable_
auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- http_
api_ stringname - Perform an exact search by name.
- model_
category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- protocols list(string)
- List of API access protocols. Valid values:
HTTP,HTTPS. - resource_
group_ stringid - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai
Protocols List<String> AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base
Path String API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy
Configs List<String> API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description String
- API description.
- enable
Auth Boolean Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- http
Api StringName - Perform an exact search by name.
- model
Category String AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- protocols List<String>
- List of API access protocols. Valid values:
HTTP,HTTPS. - resource
Group StringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- type String
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai
Protocols string[] AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base
Path string API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy
Configs string[] API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description string
- API description.
- enable
Auth boolean Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- http
Api stringName - Perform an exact search by name.
- model
Category string AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- protocols string[]
- List of API access protocols. Valid values:
HTTP,HTTPS. - resource
Group stringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- type string
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai_
protocols Sequence[str] AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base_
path str API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy_
configs Sequence[str] API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description str
- API description.
- enable_
auth bool Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- http_
api_ strname - Perform an exact search by name.
- model_
category str AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- protocols Sequence[str]
- List of API access protocols. Valid values:
HTTP,HTTPS. - resource_
group_ strid - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- type str
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
- ai
Protocols List<String> AI API protocols. Currently the supported value is
OpenAI/v1.NOTE: This parameter is immutable. Changing it after creation has no effect.
- base
Path String API base path. It must start with a forward slash (/), be at most 256 bytes long, and must not contain spaces. It is required when
typeisRest; whentypeisLLM,Ai, orAgent, it can be omitted and defaults to/.NOTE: This parameter is immutable. Changing it after creation has no effect.
- deploy
Configs List<String> API deployment configurations. It is required when
typeisLLMorAi, and only a single deployment configuration can be specified. Other types do not need this field.NOTE: This parameter is only evaluated during resource creation and update. Modifying it in isolation will not trigger any action.
- description String
- API description.
- enable
Auth Boolean Whether to enable authentication.
NOTE: This parameter is immutable. Changing it after creation has no effect.
- http
Api StringName - Perform an exact search by name.
- model
Category String AI model category
NOTE: This parameter is immutable. Changing it after creation has no effect.
- protocols List<String>
- List of API access protocols. Valid values:
HTTP,HTTPS. - resource
Group StringId - The ID of the resource group. It can be modified to migrate the resource to another resource group.
- type String
- The type of the HTTP API. Multiple types are supported and must be separated by commas (,).
- Http
- Rest
- LLM
- WebSocket
- HttpIngress
Import
APIG Http Api can be imported using the id, e.g.
$ pulumi import alicloud:apig/httpApi:HttpApi example <http_api_id>
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
alicloudTerraform Provider.
published on Monday, Aug 24, 2026 by Pulumi