Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
published on Thursday, Sep 17, 2026 by Pulumi
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
published on Thursday, Sep 17, 2026 by Pulumi
This data source provides Apig Route available to the user.What is Route
NOTE: Available since v1.287.0.
Example 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 routeHttpapiArr = new alicloud.apig.HttpApi("route_httpapi_arr", {
httpApiName: "cspec-route-arr-httpapi",
protocols: ["HTTP"],
type: "Rest",
description: "array test httpapi",
basePath: "/cspec-route-arr",
});
const defaultRoute = new alicloud.apig.Route("default", {
domainInfos: [
{},
{},
],
backend: {
services: [
{
version: "v1.0",
port: 8080,
protocol: "HTTP",
weight: 70,
serviceId: "svc-a",
},
{
version: "v1.0",
port: 8081,
protocol: "HTTP",
weight: 30,
serviceId: "svc-b",
},
],
scene: "SingleService",
},
description: "array route description",
routeName: "cspec-arr-route",
httpApiId: routeHttpapiArr.id,
match: {
path: {
type: "Prefix",
value: "/arr-path",
},
headers: [
{
type: "Exact",
value: "v1",
name: "h1",
},
{
type: "Prefix",
value: "v2",
name: "h2",
},
],
queryParams: [
{
type: "Exact",
value: "v1",
name: "q1",
},
{
type: "Prefix",
value: "v2",
name: "q2",
},
],
methods: [
"GET",
"POST",
"PUT",
],
ignoreUriCase: false,
},
});
const _default = alicloud.apig.getRoutesOutput({
ids: [defaultRoute.id],
nameRegex: defaultRoute.routeName,
httpApiId: routeHttpapiArr.id,
routeName: "cspec-arr-route",
});
export const alicloudApigRouteExampleId = _default.apply(_default => _default.routes?.[0]?.id);
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
route_httpapi_arr = alicloud.apig.HttpApi("route_httpapi_arr",
http_api_name="cspec-route-arr-httpapi",
protocols=["HTTP"],
type="Rest",
description="array test httpapi",
base_path="/cspec-route-arr")
default_route = alicloud.apig.Route("default",
domain_infos=[
{},
{},
],
backend={
"services": [
{
"version": "v1.0",
"port": 8080,
"protocol": "HTTP",
"weight": 70,
"service_id": "svc-a",
},
{
"version": "v1.0",
"port": 8081,
"protocol": "HTTP",
"weight": 30,
"service_id": "svc-b",
},
],
"scene": "SingleService",
},
description="array route description",
route_name="cspec-arr-route",
http_api_id=route_httpapi_arr.id,
match={
"path": {
"type": "Prefix",
"value": "/arr-path",
},
"headers": [
{
"type": "Exact",
"value": "v1",
"name": "h1",
},
{
"type": "Prefix",
"value": "v2",
"name": "h2",
},
],
"query_params": [
{
"type": "Exact",
"value": "v1",
"name": "q1",
},
{
"type": "Prefix",
"value": "v2",
"name": "q2",
},
],
"methods": [
"GET",
"POST",
"PUT",
],
"ignore_uri_case": False,
})
default = alicloud.apig.get_routes_output(ids=[default_route.id],
name_regex=default_route.route_name,
http_api_id=route_httpapi_arr.id,
route_name="cspec-arr-route")
pulumi.export("alicloudApigRouteExampleId", default.routes[0].id)
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apig"
"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
}
routeHttpapiArr, err := apig.NewHttpApi(ctx, "route_httpapi_arr", &apig.HttpApiArgs{
HttpApiName: pulumi.String("cspec-route-arr-httpapi"),
Protocols: pulumi.StringArray{
pulumi.String("HTTP"),
},
Type: pulumi.String("Rest"),
Description: pulumi.String("array test httpapi"),
BasePath: pulumi.String("/cspec-route-arr"),
})
if err != nil {
return err
}
defaultRoute, err := apig.NewRoute(ctx, "default", &apig.RouteArgs{
DomainInfos: []map[string]interface{}{
map[string]interface{}{},
map[string]interface{}{},
},
Backend: &apig.RouteBackendArgs{
Services: apig.RouteBackendServiceArray{
&apig.RouteBackendServiceArgs{
Version: pulumi.String("v1.0"),
Port: pulumi.Int(8080),
Protocol: pulumi.String("HTTP"),
Weight: pulumi.Int(70),
ServiceId: pulumi.String("svc-a"),
},
&apig.RouteBackendServiceArgs{
Version: pulumi.String("v1.0"),
Port: pulumi.Int(8081),
Protocol: pulumi.String("HTTP"),
Weight: pulumi.Int(30),
ServiceId: pulumi.String("svc-b"),
},
},
Scene: pulumi.String("SingleService"),
},
Description: pulumi.String("array route description"),
RouteName: pulumi.String("cspec-arr-route"),
HttpApiId: routeHttpapiArr.ID().ToIDOutput().ToStringOutput(),
Match: &apig.RouteMatchArgs{
Path: &apig.RouteMatchPathArgs{
Type: pulumi.String("Prefix"),
Value: pulumi.String("/arr-path"),
},
Headers: apig.RouteMatchHeaderArray{
&apig.RouteMatchHeaderArgs{
Type: pulumi.String("Exact"),
Value: pulumi.String("v1"),
Name: pulumi.String("h1"),
},
&apig.RouteMatchHeaderArgs{
Type: pulumi.String("Prefix"),
Value: pulumi.String("v2"),
Name: pulumi.String("h2"),
},
},
QueryParams: apig.RouteMatchQueryParamArray{
&apig.RouteMatchQueryParamArgs{
Type: pulumi.String("Exact"),
Value: pulumi.String("v1"),
Name: pulumi.String("q1"),
},
&apig.RouteMatchQueryParamArgs{
Type: pulumi.String("Prefix"),
Value: pulumi.String("v2"),
Name: pulumi.String("q2"),
},
},
Methods: pulumi.StringArray{
pulumi.String("GET"),
pulumi.String("POST"),
pulumi.String("PUT"),
},
IgnoreUriCase: pulumi.Bool(false),
},
})
if err != nil {
return err
}
_default := apig.GetRoutesOutput(ctx, apig.GetRoutesOutputArgs{
Ids: pulumi.StringArray{
defaultRoute.ID().ToIDOutput().ToStringOutput(),
},
NameRegex: defaultRoute.RouteName,
HttpApiId: routeHttpapiArr.ID().ToIDOutput().ToStringOutput(),
RouteName: pulumi.String("cspec-arr-route"),
}, nil)
ctx.Export("alicloudApigRouteExampleId", _default.ApplyT(func(_default apig.GetRoutesResult) (*string, error) {
return _default.Routes[0].Id, nil
}).(pulumi.StringPtrOutput))
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 routeHttpapiArr = new AliCloud.Apig.HttpApi("route_httpapi_arr", new()
{
HttpApiName = "cspec-route-arr-httpapi",
Protocols = new[]
{
"HTTP",
},
Type = "Rest",
Description = "array test httpapi",
BasePath = "/cspec-route-arr",
});
var defaultRoute = new AliCloud.Apig.Route("default", new()
{
DomainInfos = new[]
{
null,
null,
},
Backend = new AliCloud.Apig.Inputs.RouteBackendArgs
{
Services = new[]
{
new AliCloud.Apig.Inputs.RouteBackendServiceArgs
{
Version = "v1.0",
Port = 8080,
Protocol = "HTTP",
Weight = 70,
ServiceId = "svc-a",
},
new AliCloud.Apig.Inputs.RouteBackendServiceArgs
{
Version = "v1.0",
Port = 8081,
Protocol = "HTTP",
Weight = 30,
ServiceId = "svc-b",
},
},
Scene = "SingleService",
},
Description = "array route description",
RouteName = "cspec-arr-route",
HttpApiId = routeHttpapiArr.Id,
Match = new AliCloud.Apig.Inputs.RouteMatchArgs
{
Path = new AliCloud.Apig.Inputs.RouteMatchPathArgs
{
Type = "Prefix",
Value = "/arr-path",
},
Headers = new[]
{
new AliCloud.Apig.Inputs.RouteMatchHeaderArgs
{
Type = "Exact",
Value = "v1",
Name = "h1",
},
new AliCloud.Apig.Inputs.RouteMatchHeaderArgs
{
Type = "Prefix",
Value = "v2",
Name = "h2",
},
},
QueryParams = new[]
{
new AliCloud.Apig.Inputs.RouteMatchQueryParamArgs
{
Type = "Exact",
Value = "v1",
Name = "q1",
},
new AliCloud.Apig.Inputs.RouteMatchQueryParamArgs
{
Type = "Prefix",
Value = "v2",
Name = "q2",
},
},
Methods = new[]
{
"GET",
"POST",
"PUT",
},
IgnoreUriCase = false,
},
});
var @default = AliCloud.Apig.GetRoutes.Invoke(new()
{
Ids = new[]
{
defaultRoute.Id,
},
NameRegex = defaultRoute.RouteName,
HttpApiId = routeHttpapiArr.Id,
RouteName = "cspec-arr-route",
});
return new Dictionary<string, object?>
{
["alicloudApigRouteExampleId"] = @default.Apply(@default => @default.Apply(getRoutesResult => getRoutesResult.Routes[0]?.Id)),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apig.HttpApi;
import com.pulumi.alicloud.apig.HttpApiArgs;
import com.pulumi.alicloud.apig.Route;
import com.pulumi.alicloud.apig.RouteArgs;
import com.pulumi.alicloud.apig.inputs.RouteBackendArgs;
import com.pulumi.alicloud.apig.inputs.RouteBackendServiceArgs;
import com.pulumi.alicloud.apig.inputs.RouteMatchArgs;
import com.pulumi.alicloud.apig.inputs.RouteMatchPathArgs;
import com.pulumi.alicloud.apig.inputs.RouteMatchHeaderArgs;
import com.pulumi.alicloud.apig.inputs.RouteMatchQueryParamArgs;
import com.pulumi.alicloud.apig.ApigFunctions;
import com.pulumi.alicloud.apig.inputs.GetRoutesArgs;
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");
var routeHttpapiArr = new HttpApi("routeHttpapiArr", HttpApiArgs.builder()
.httpApiName("cspec-route-arr-httpapi")
.protocols("HTTP")
.type("Rest")
.description("array test httpapi")
.basePath("/cspec-route-arr")
.build());
var defaultRoute = new Route("defaultRoute", RouteArgs.builder()
.domainInfos(Arrays.asList(
Map.ofEntries(
),
Map.ofEntries(
)))
.backend(RouteBackendArgs.builder()
.services(
RouteBackendServiceArgs.builder()
.version("v1.0")
.port(8080)
.protocol("HTTP")
.weight(70)
.serviceId("svc-a")
.build(),
RouteBackendServiceArgs.builder()
.version("v1.0")
.port(8081)
.protocol("HTTP")
.weight(30)
.serviceId("svc-b")
.build())
.scene("SingleService")
.build())
.description("array route description")
.routeName("cspec-arr-route")
.httpApiId(routeHttpapiArr.id())
.match(RouteMatchArgs.builder()
.path(RouteMatchPathArgs.builder()
.type("Prefix")
.value("/arr-path")
.build())
.headers(
RouteMatchHeaderArgs.builder()
.type("Exact")
.value("v1")
.name("h1")
.build(),
RouteMatchHeaderArgs.builder()
.type("Prefix")
.value("v2")
.name("h2")
.build())
.queryParams(
RouteMatchQueryParamArgs.builder()
.type("Exact")
.value("v1")
.name("q1")
.build(),
RouteMatchQueryParamArgs.builder()
.type("Prefix")
.value("v2")
.name("q2")
.build())
.methods(
"GET",
"POST",
"PUT")
.ignoreUriCase(false)
.build())
.build());
final var default = ApigFunctions.getRoutes(GetRoutesArgs.builder()
.ids(defaultRoute.id())
.nameRegex(defaultRoute.routeName())
.httpApiId(routeHttpapiArr.id())
.routeName("cspec-arr-route")
.build());
ctx.export("alicloudApigRouteExampleId", default_.applyValue(_default_ -> _default_.routes()[0].id()));
}
}
configuration:
name:
type: string
default: terraform-example
resources:
routeHttpapiArr:
type: alicloud:apig:HttpApi
name: route_httpapi_arr
properties:
httpApiName: cspec-route-arr-httpapi
protocols:
- HTTP
type: Rest
description: array test httpapi
basePath: /cspec-route-arr
defaultRoute:
type: alicloud:apig:Route
name: default
properties:
domainInfos:
- {}
- {}
backend:
services:
- version: v1.0
port: '8080'
protocol: HTTP
weight: '70'
serviceId: svc-a
- version: v1.0
port: '8081'
protocol: HTTP
weight: '30'
serviceId: svc-b
scene: SingleService
description: array route description
routeName: cspec-arr-route
httpApiId: ${routeHttpapiArr.id}
match:
path:
type: Prefix
value: /arr-path
headers:
- type: Exact
value: v1
name: h1
- type: Prefix
value: v2
name: h2
queryParams:
- type: Exact
value: v1
name: q1
- type: Prefix
value: v2
name: q2
methods:
- GET
- POST
- PUT
ignoreUriCase: false
variables:
default:
fn::invoke:
function: alicloud:apig:getRoutes
arguments:
ids:
- ${defaultRoute.id}
nameRegex: ${defaultRoute.routeName}
httpApiId: ${routeHttpapiArr.id}
routeName: cspec-arr-route
outputs:
alicloudApigRouteExampleId: ${default.routes[0].id}
pulumi {
required_providers {
alicloud = {
source = "pulumi/alicloud"
}
}
}
data "alicloud_apig_getroutes" "default" {
ids = [alicloud_apig_route.default.id]
name_regex = alicloud_apig_route.default.route_name
http_api_id = alicloud_apig_httpapi.route_httpapi_arr.id
route_name = "cspec-arr-route"
}
resource "alicloud_apig_httpapi" "route_httpapi_arr" {
http_api_name = "cspec-route-arr-httpapi"
protocols = ["HTTP"]
type = "Rest"
description = "array test httpapi"
base_path = "/cspec-route-arr"
}
resource "alicloud_apig_route" "default" {
domain_infos = [{}, {}]
backend = {
services = [{
"version" = "v1.0"
"port" = "8080"
"protocol" = "HTTP"
"weight" = "70"
"serviceId" = "svc-a"
}, {
"version" = "v1.0"
"port" = "8081"
"protocol" = "HTTP"
"weight" = "30"
"serviceId" = "svc-b"
}]
scene = "SingleService"
}
description = "array route description"
route_name = "cspec-arr-route"
http_api_id = alicloud_apig_httpapi.route_httpapi_arr.id
match = {
path = {
type = "Prefix"
value = "/arr-path"
}
headers = [{
"type" = "Exact"
"value" = "v1"
"name" = "h1"
}, {
"type" = "Prefix"
"value" = "v2"
"name" = "h2"
}]
query_params = [{
"type" = "Exact"
"value" = "v1"
"name" = "q1"
}, {
"type" = "Prefix"
"value" = "v2"
"name" = "q2"
}]
methods = ["GET", "POST", "PUT"]
ignore_uri_case = false
}
}
variable "name" {
type = string
default = "terraform-example"
}
output "alicloudApigRouteExampleId" {
value = data.alicloud_apig_getroutes.default.routes[0].id
}
Using getRoutes
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRoutes(args: GetRoutesArgs, opts?: InvokeOptions): Promise<GetRoutesResult>
function getRoutesOutput(args: GetRoutesOutputArgs, opts?: InvokeOutputOptions): Output<GetRoutesResult>def get_routes(environment_info: Optional[GetRoutesEnvironmentInfo] = None,
http_api_id: Optional[str] = None,
ids: Optional[Sequence[str]] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
route_name: Optional[str] = None,
status: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRoutesResult
def get_routes_output(environment_info: pulumi.Input[Optional[GetRoutesEnvironmentInfoArgs]] = None,
http_api_id: pulumi.Input[Optional[str]] = None,
ids: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
name_regex: pulumi.Input[Optional[str]] = None,
output_file: pulumi.Input[Optional[str]] = None,
route_name: pulumi.Input[Optional[str]] = None,
status: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetRoutesResult]func GetRoutes(ctx *Context, args *GetRoutesArgs, opts ...InvokeOption) (*GetRoutesResult, error)
func GetRoutesOutput(ctx *Context, args *GetRoutesOutputArgs, opts ...InvokeOption) GetRoutesResultOutput> Note: This function is named GetRoutes in the Go SDK.
public static class GetRoutes
{
public static Task<GetRoutesResult> InvokeAsync(GetRoutesArgs args, InvokeOptions? opts = null)
public static Output<GetRoutesResult> Invoke(GetRoutesInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetRoutesResult> Invoke(GetRoutesInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOptions options)
public static Output<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOptions options)
public static Output<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOutputOptions options)
fn::invoke:
function: alicloud:apig/getRoutes:getRoutes
arguments:
# arguments dictionarydata "alicloud_apig_get_routes" "name" {
# arguments
}The following arguments are supported:
- Http
Api stringId - The ID of the HTTP API to which the route belongs.
- Environment
Info Pulumi.Ali Cloud. Apig. Inputs. Get Routes Environment Info - The environment information of the route. See
environmentInfobelow. - Ids List<string>
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - Name
Regex string - A regex string to filter results by Route name.
- Output
File string - File name where to save data source results (after running
pulumi preview). - Route
Name string - The name of the route.
- Status string
- The deployment status of the route.
- Http
Api stringId - The ID of the HTTP API to which the route belongs.
- Environment
Info GetRoutes Environment Info - The environment information of the route. See
environmentInfobelow. - Ids []string
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - Name
Regex string - A regex string to filter results by Route name.
- Output
File string - File name where to save data source results (after running
pulumi preview). - Route
Name string - The name of the route.
- Status string
- The deployment status of the route.
- http_
api_ stringid - The ID of the HTTP API to which the route belongs.
- environment_
info object - The environment information of the route. See
environmentInfobelow. - ids list(string)
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - name_
regex string - A regex string to filter results by Route name.
- output_
file string - File name where to save data source results (after running
pulumi preview). - route_
name string - The name of the route.
- status string
- The deployment status of the route.
- http
Api StringId - The ID of the HTTP API to which the route belongs.
- environment
Info GetRoutes Environment Info - The environment information of the route. See
environmentInfobelow. - ids List<String>
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - name
Regex String - A regex string to filter results by Route name.
- output
File String - File name where to save data source results (after running
pulumi preview). - route
Name String - The name of the route.
- status String
- The deployment status of the route.
- http
Api stringId - The ID of the HTTP API to which the route belongs.
- environment
Info GetRoutes Environment Info - The environment information of the route. See
environmentInfobelow. - ids string[]
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - name
Regex string - A regex string to filter results by Route name.
- output
File string - File name where to save data source results (after running
pulumi preview). - route
Name string - The name of the route.
- status string
- The deployment status of the route.
- http_
api_ strid - The ID of the HTTP API to which the route belongs.
- environment_
info GetRoutes Environment Info - The environment information of the route. See
environmentInfobelow. - ids Sequence[str]
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - name_
regex str - A regex string to filter results by Route name.
- output_
file str - File name where to save data source results (after running
pulumi preview). - route_
name str - The name of the route.
- status str
- The deployment status of the route.
- http
Api StringId - The ID of the HTTP API to which the route belongs.
- environment
Info Property Map - The environment information of the route. See
environmentInfobelow. - ids List<String>
- A list of Route IDs. The value is formulated as
<http_api_id>:<route_id>. - name
Regex String - A regex string to filter results by Route name.
- output
File String - File name where to save data source results (after running
pulumi preview). - route
Name String - The name of the route.
- status String
- The deployment status of the route.
getRoutes Result
The following output properties are available:
- Http
Api stringId - Id string
- The provider-assigned unique ID for this managed resource.
- Ids List<string>
- A list of Route IDs.
- Names List<string>
- A list of name of Routes.
- Routes
List<Pulumi.
Ali Cloud. Apig. Outputs. Get Routes Route> - A list of Route Entries. Each element contains the following attributes:
- Environment
Info Pulumi.Ali Cloud. Apig. Outputs. Get Routes Environment Info - The environment information of the route.
- Name
Regex string - Output
File string - Route
Name string - The name of the route.
- Status string
- The deployment status of the route.
- Http
Api stringId - Id string
- The provider-assigned unique ID for this managed resource.
- Ids []string
- A list of Route IDs.
- Names []string
- A list of name of Routes.
- Routes
[]Get
Routes Route - A list of Route Entries. Each element contains the following attributes:
- Environment
Info GetRoutes Environment Info - The environment information of the route.
- Name
Regex string - Output
File string - Route
Name string - The name of the route.
- Status string
- The deployment status of the route.
- http_
api_ stringid - id string
- The provider-assigned unique ID for this managed resource.
- ids list(string)
- A list of Route IDs.
- names list(string)
- A list of name of Routes.
- routes list(object)
- A list of Route Entries. Each element contains the following attributes:
- environment_
info object - The environment information of the route.
- name_
regex string - output_
file string - route_
name string - The name of the route.
- status string
- The deployment status of the route.
- http
Api StringId - id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- A list of Route IDs.
- names List<String>
- A list of name of Routes.
- routes
List<Get
Routes Route> - A list of Route Entries. Each element contains the following attributes:
- environment
Info GetRoutes Environment Info - The environment information of the route.
- name
Regex String - output
File String - route
Name String - The name of the route.
- status String
- The deployment status of the route.
- http
Api stringId - id string
- The provider-assigned unique ID for this managed resource.
- ids string[]
- A list of Route IDs.
- names string[]
- A list of name of Routes.
- routes
Get
Routes Route[] - A list of Route Entries. Each element contains the following attributes:
- environment
Info GetRoutes Environment Info - The environment information of the route.
- name
Regex string - output
File string - route
Name string - The name of the route.
- status string
- The deployment status of the route.
- http_
api_ strid - id str
- The provider-assigned unique ID for this managed resource.
- ids Sequence[str]
- A list of Route IDs.
- names Sequence[str]
- A list of name of Routes.
- routes
Sequence[Get
Routes Route] - A list of Route Entries. Each element contains the following attributes:
- environment_
info GetRoutes Environment Info - The environment information of the route.
- name_
regex str - output_
file str - route_
name str - The name of the route.
- status str
- The deployment status of the route.
- http
Api StringId - id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- A list of Route IDs.
- names List<String>
- A list of name of Routes.
- routes List<Property Map>
- A list of Route Entries. Each element contains the following attributes:
- environment
Info Property Map - The environment information of the route.
- name
Regex String - output
File String - route
Name String - The name of the route.
- status String
- The deployment status of the route.
Supporting Types
GetRoutesEnvironmentInfo
- Alias string
- The alias of the environment name.
- Gateway
Infos List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Environment Info Gateway Info> - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - Name string
- The name of the second-level domain name.
- Sub
Domains List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Environment Info Sub Domain> - The default second-level domain names of the environment. See
subDomainsbelow. - Environment
Id string - The environment ID.
- Alias string
- The alias of the environment name.
- Gateway
Infos []GetRoutes Environment Info Gateway Info - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - Name string
- The name of the second-level domain name.
- Sub
Domains []GetRoutes Environment Info Sub Domain - The default second-level domain names of the environment. See
subDomainsbelow. - Environment
Id string - The environment ID.
- alias string
- The alias of the environment name.
- gateway_
infos list(object) - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name string
- The name of the second-level domain name.
- sub_
domains list(object) - The default second-level domain names of the environment. See
subDomainsbelow. - environment_
id string - The environment ID.
- alias String
- The alias of the environment name.
- gateway
Infos List<GetRoutes Environment Info Gateway Info> - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name String
- The name of the second-level domain name.
- sub
Domains List<GetRoutes Environment Info Sub Domain> - The default second-level domain names of the environment. See
subDomainsbelow. - environment
Id String - The environment ID.
- alias string
- The alias of the environment name.
- gateway
Infos GetRoutes Environment Info Gateway Info[] - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name string
- The name of the second-level domain name.
- sub
Domains GetRoutes Environment Info Sub Domain[] - The default second-level domain names of the environment. See
subDomainsbelow. - environment
Id string - The environment ID.
- alias str
- The alias of the environment name.
- gateway_
infos Sequence[GetRoutes Environment Info Gateway Info] - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name str
- The name of the second-level domain name.
- sub_
domains Sequence[GetRoutes Environment Info Sub Domain] - The default second-level domain names of the environment. See
subDomainsbelow. - environment_
id str - The environment ID.
- alias String
- The alias of the environment name.
- gateway
Infos List<Property Map> - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name String
- The name of the second-level domain name.
- sub
Domains List<Property Map> - The default second-level domain names of the environment. See
subDomainsbelow. - environment
Id String - The environment ID.
GetRoutesEnvironmentInfoGatewayInfo
- Gateway
Edition string - The edition of the gateway instance.
- Gateway
Id string - The ID of the Cloud-native API Gateway.
- Name string
- The parameter name.
- Gateway
Edition string - The edition of the gateway instance.
- Gateway
Id string - The ID of the Cloud-native API Gateway.
- Name string
- The parameter name.
- gateway_
edition string - The edition of the gateway instance.
- gateway_
id string - The ID of the Cloud-native API Gateway.
- name string
- The parameter name.
- gateway
Edition String - The edition of the gateway instance.
- gateway
Id String - The ID of the Cloud-native API Gateway.
- name String
- The parameter name.
- gateway
Edition string - The edition of the gateway instance.
- gateway
Id string - The ID of the Cloud-native API Gateway.
- name string
- The parameter name.
- gateway_
edition str - The edition of the gateway instance.
- gateway_
id str - The ID of the Cloud-native API Gateway.
- name str
- The parameter name.
- gateway
Edition String - The edition of the gateway instance.
- gateway
Id String - The ID of the Cloud-native API Gateway.
- name String
- The parameter name.
GetRoutesEnvironmentInfoSubDomain
- Domain
Id string - The ID of the second-level domain name.
- Name string
- The parameter name.
- Network
Type string - The domain access type, such as Intranet or Internet.
- Protocol string
- The domain protocol, such as HTTP or HTTPS.
- Domain
Id string - The ID of the second-level domain name.
- Name string
- The parameter name.
- Network
Type string - The domain access type, such as Intranet or Internet.
- Protocol string
- The domain protocol, such as HTTP or HTTPS.
- domain_
id string - The ID of the second-level domain name.
- name string
- The parameter name.
- network_
type string - The domain access type, such as Intranet or Internet.
- protocol string
- The domain protocol, such as HTTP or HTTPS.
- domain
Id String - The ID of the second-level domain name.
- name String
- The parameter name.
- network
Type String - The domain access type, such as Intranet or Internet.
- protocol String
- The domain protocol, such as HTTP or HTTPS.
- domain
Id string - The ID of the second-level domain name.
- name string
- The parameter name.
- network
Type string - The domain access type, such as Intranet or Internet.
- protocol string
- The domain protocol, such as HTTP or HTTPS.
- domain_
id str - The ID of the second-level domain name.
- name str
- The parameter name.
- network_
type str - The domain access type, such as Intranet or Internet.
- protocol str
- The domain protocol, such as HTTP or HTTPS.
- domain
Id String - The ID of the second-level domain name.
- name String
- The parameter name.
- network
Type String - The domain access type, such as Intranet or Internet.
- protocol String
- The domain protocol, such as HTTP or HTTPS.
GetRoutesRoute
- Backends
List<Pulumi.
Ali Cloud. Apig. Inputs. Get Routes Route Backend> - Backend service.
- Builtin string
- Indicates whether the route is a built-in route.
- Create
Time string - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- Description string
- The description of the route.
- Domain
Infos List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Route Domain Info> - The domain name information.
- Environment
Infos List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Route Environment Info> - The environment information of the route. See
environmentInfobelow. - Gateway
Status Dictionary<string, string> - The publishing status of the route on each gateway.
- Id string
- The ID of the resource supplied above.
- Matches
List<Pulumi.
Ali Cloud. Apig. Inputs. Get Routes Route Match> - The route match rule.
- Route
Id string - The route ID.
- Route
Name string - The name of the route.
- Status string
- The deployment status of the route.
- Update
Time string - The update time in Greenwich Mean Time (GMT).
- Backends
[]Get
Routes Route Backend - Backend service.
- Builtin string
- Indicates whether the route is a built-in route.
- Create
Time string - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- Description string
- The description of the route.
- Domain
Infos []GetRoutes Route Domain Info - The domain name information.
- Environment
Infos []GetRoutes Route Environment Info - The environment information of the route. See
environmentInfobelow. - Gateway
Status map[string]string - The publishing status of the route on each gateway.
- Id string
- The ID of the resource supplied above.
- Matches
[]Get
Routes Route Match - The route match rule.
- Route
Id string - The route ID.
- Route
Name string - The name of the route.
- Status string
- The deployment status of the route.
- Update
Time string - The update time in Greenwich Mean Time (GMT).
- backends list(object)
- Backend service.
- builtin string
- Indicates whether the route is a built-in route.
- create_
time string - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- description string
- The description of the route.
- domain_
infos list(object) - The domain name information.
- environment_
infos list(object) - The environment information of the route. See
environmentInfobelow. - gateway_
status map(string) - The publishing status of the route on each gateway.
- id string
- The ID of the resource supplied above.
- matches list(object)
- The route match rule.
- route_
id string - The route ID.
- route_
name string - The name of the route.
- status string
- The deployment status of the route.
- update_
time string - The update time in Greenwich Mean Time (GMT).
- backends
List<Get
Routes Route Backend> - Backend service.
- builtin String
- Indicates whether the route is a built-in route.
- create
Time String - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- description String
- The description of the route.
- domain
Infos List<GetRoutes Route Domain Info> - The domain name information.
- environment
Infos List<GetRoutes Route Environment Info> - The environment information of the route. See
environmentInfobelow. - gateway
Status Map<String,String> - The publishing status of the route on each gateway.
- id String
- The ID of the resource supplied above.
- matches
List<Get
Routes Route Match> - The route match rule.
- route
Id String - The route ID.
- route
Name String - The name of the route.
- status String
- The deployment status of the route.
- update
Time String - The update time in Greenwich Mean Time (GMT).
- backends
Get
Routes Route Backend[] - Backend service.
- builtin string
- Indicates whether the route is a built-in route.
- create
Time string - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- description string
- The description of the route.
- domain
Infos GetRoutes Route Domain Info[] - The domain name information.
- environment
Infos GetRoutes Route Environment Info[] - The environment information of the route. See
environmentInfobelow. - gateway
Status {[key: string]: string} - The publishing status of the route on each gateway.
- id string
- The ID of the resource supplied above.
- matches
Get
Routes Route Match[] - The route match rule.
- route
Id string - The route ID.
- route
Name string - The name of the route.
- status string
- The deployment status of the route.
- update
Time string - The update time in Greenwich Mean Time (GMT).
- backends
Sequence[Get
Routes Route Backend] - Backend service.
- builtin str
- Indicates whether the route is a built-in route.
- create_
time str - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- description str
- The description of the route.
- domain_
infos Sequence[GetRoutes Route Domain Info] - The domain name information.
- environment_
infos Sequence[GetRoutes Route Environment Info] - The environment information of the route. See
environmentInfobelow. - gateway_
status Mapping[str, str] - The publishing status of the route on each gateway.
- id str
- The ID of the resource supplied above.
- matches
Sequence[Get
Routes Route Match] - The route match rule.
- route_
id str - The route ID.
- route_
name str - The name of the route.
- status str
- The deployment status of the route.
- update_
time str - The update time in Greenwich Mean Time (GMT).
- backends List<Property Map>
- Backend service.
- builtin String
- Indicates whether the route is a built-in route.
- create
Time String - The creation time in UTC format: yyyy-MM-ddTHH:mm:ssZ.
- description String
- The description of the route.
- domain
Infos List<Property Map> - The domain name information.
- environment
Infos List<Property Map> - The environment information of the route. See
environmentInfobelow. - gateway
Status Map<String> - The publishing status of the route on each gateway.
- id String
- The ID of the resource supplied above.
- matches List<Property Map>
- The route match rule.
- route
Id String - The route ID.
- route
Name String - The name of the route.
- status String
- The deployment status of the route.
- update
Time String - The update time in Greenwich Mean Time (GMT).
GetRoutesRouteBackend
- Scene string
- The backend service scenario.
- Services
List<Pulumi.
Ali Cloud. Apig. Inputs. Get Routes Route Backend Service> - Backend service.
- Scene string
- The backend service scenario.
- Services
[]Get
Routes Route Backend Service - Backend service.
- scene string
- The backend service scenario.
- services list(object)
- Backend service.
- scene String
- The backend service scenario.
- services
List<Get
Routes Route Backend Service> - Backend service.
- scene string
- The backend service scenario.
- services
Get
Routes Route Backend Service[] - Backend service.
- scene str
- The backend service scenario.
- services
Sequence[Get
Routes Route Backend Service] - Backend service.
- scene String
- The backend service scenario.
- services List<Property Map>
- Backend service.
GetRoutesRouteBackendService
GetRoutesRouteDomainInfo
GetRoutesRouteEnvironmentInfo
- Alias string
- The alias of the environment name.
- Environment
Id string - The environment ID.
- Gateway
Infos List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Route Environment Info Gateway Info> - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - Name string
- The name of the second-level domain name.
- Sub
Domains List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Route Environment Info Sub Domain> - The default second-level domain names of the environment. See
subDomainsbelow.
- Alias string
- The alias of the environment name.
- Environment
Id string - The environment ID.
- Gateway
Infos []GetRoutes Route Environment Info Gateway Info - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - Name string
- The name of the second-level domain name.
- Sub
Domains []GetRoutes Route Environment Info Sub Domain - The default second-level domain names of the environment. See
subDomainsbelow.
- alias string
- The alias of the environment name.
- environment_
id string - The environment ID.
- gateway_
infos list(object) - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name string
- The name of the second-level domain name.
- sub_
domains list(object) - The default second-level domain names of the environment. See
subDomainsbelow.
- alias String
- The alias of the environment name.
- environment
Id String - The environment ID.
- gateway
Infos List<GetRoutes Route Environment Info Gateway Info> - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name String
- The name of the second-level domain name.
- sub
Domains List<GetRoutes Route Environment Info Sub Domain> - The default second-level domain names of the environment. See
subDomainsbelow.
- alias string
- The alias of the environment name.
- environment
Id string - The environment ID.
- gateway
Infos GetRoutes Route Environment Info Gateway Info[] - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name string
- The name of the second-level domain name.
- sub
Domains GetRoutes Route Environment Info Sub Domain[] - The default second-level domain names of the environment. See
subDomainsbelow.
- alias str
- The alias of the environment name.
- environment_
id str - The environment ID.
- gateway_
infos Sequence[GetRoutes Route Environment Info Gateway Info] - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name str
- The name of the second-level domain name.
- sub_
domains Sequence[GetRoutes Route Environment Info Sub Domain] - The default second-level domain names of the environment. See
subDomainsbelow.
- alias String
- The alias of the environment name.
- environment
Id String - The environment ID.
- gateway
Infos List<Property Map> - The gateway instance information corresponding to the environment. See
gatewayInfobelow. - name String
- The name of the second-level domain name.
- sub
Domains List<Property Map> - The default second-level domain names of the environment. See
subDomainsbelow.
GetRoutesRouteEnvironmentInfoGatewayInfo
- Gateway
Edition string - The edition of the gateway instance.
- Gateway
Id string - The ID of the Cloud-native API Gateway.
- Name string
- The parameter name.
- Gateway
Edition string - The edition of the gateway instance.
- Gateway
Id string - The ID of the Cloud-native API Gateway.
- Name string
- The parameter name.
- gateway_
edition string - The edition of the gateway instance.
- gateway_
id string - The ID of the Cloud-native API Gateway.
- name string
- The parameter name.
- gateway
Edition String - The edition of the gateway instance.
- gateway
Id String - The ID of the Cloud-native API Gateway.
- name String
- The parameter name.
- gateway
Edition string - The edition of the gateway instance.
- gateway
Id string - The ID of the Cloud-native API Gateway.
- name string
- The parameter name.
- gateway_
edition str - The edition of the gateway instance.
- gateway_
id str - The ID of the Cloud-native API Gateway.
- name str
- The parameter name.
- gateway
Edition String - The edition of the gateway instance.
- gateway
Id String - The ID of the Cloud-native API Gateway.
- name String
- The parameter name.
GetRoutesRouteEnvironmentInfoSubDomain
- Domain
Id string - The ID of the second-level domain name.
- Name string
- The parameter name.
- Network
Type string - The domain access type, such as Intranet or Internet.
- Protocol string
- The domain protocol, such as HTTP or HTTPS.
- Domain
Id string - The ID of the second-level domain name.
- Name string
- The parameter name.
- Network
Type string - The domain access type, such as Intranet or Internet.
- Protocol string
- The domain protocol, such as HTTP or HTTPS.
- domain_
id string - The ID of the second-level domain name.
- name string
- The parameter name.
- network_
type string - The domain access type, such as Intranet or Internet.
- protocol string
- The domain protocol, such as HTTP or HTTPS.
- domain
Id String - The ID of the second-level domain name.
- name String
- The parameter name.
- network
Type String - The domain access type, such as Intranet or Internet.
- protocol String
- The domain protocol, such as HTTP or HTTPS.
- domain
Id string - The ID of the second-level domain name.
- name string
- The parameter name.
- network
Type string - The domain access type, such as Intranet or Internet.
- protocol string
- The domain protocol, such as HTTP or HTTPS.
- domain_
id str - The ID of the second-level domain name.
- name str
- The parameter name.
- network_
type str - The domain access type, such as Intranet or Internet.
- protocol str
- The domain protocol, such as HTTP or HTTPS.
- domain
Id String - The ID of the second-level domain name.
- name String
- The parameter name.
- network
Type String - The domain access type, such as Intranet or Internet.
- protocol String
- The domain protocol, such as HTTP or HTTPS.
GetRoutesRouteMatch
- Headers
List<Pulumi.
Ali Cloud. Apig. Inputs. Get Routes Route Match Header> - The list of HTTP request header matching rules.
- Ignore
Uri boolCase - Specifies whether the path is case-sensitive.
- Methods List<string>
- The request method.
- Paths
List<Pulumi.
Ali Cloud. Apig. Inputs. Get Routes Route Match Path> - The path rule.
- Query
Params List<Pulumi.Ali Cloud. Apig. Inputs. Get Routes Route Match Query Param> - The matching rules for query parameters.
- Headers
[]Get
Routes Route Match Header - The list of HTTP request header matching rules.
- Ignore
Uri boolCase - Specifies whether the path is case-sensitive.
- Methods []string
- The request method.
- Paths
[]Get
Routes Route Match Path - The path rule.
- Query
Params []GetRoutes Route Match Query Param - The matching rules for query parameters.
- headers list(object)
- The list of HTTP request header matching rules.
- ignore_
uri_ boolcase - Specifies whether the path is case-sensitive.
- methods list(string)
- The request method.
- paths list(object)
- The path rule.
- query_
params list(object) - The matching rules for query parameters.
- headers
List<Get
Routes Route Match Header> - The list of HTTP request header matching rules.
- ignore
Uri BooleanCase - Specifies whether the path is case-sensitive.
- methods List<String>
- The request method.
- paths
List<Get
Routes Route Match Path> - The path rule.
- query
Params List<GetRoutes Route Match Query Param> - The matching rules for query parameters.
- headers
Get
Routes Route Match Header[] - The list of HTTP request header matching rules.
- ignore
Uri booleanCase - Specifies whether the path is case-sensitive.
- methods string[]
- The request method.
- paths
Get
Routes Route Match Path[] - The path rule.
- query
Params GetRoutes Route Match Query Param[] - The matching rules for query parameters.
- headers
Sequence[Get
Routes Route Match Header] - The list of HTTP request header matching rules.
- ignore_
uri_ boolcase - Specifies whether the path is case-sensitive.
- methods Sequence[str]
- The request method.
- paths
Sequence[Get
Routes Route Match Path] - The path rule.
- query_
params Sequence[GetRoutes Route Match Query Param] - The matching rules for query parameters.
- headers List<Property Map>
- The list of HTTP request header matching rules.
- ignore
Uri BooleanCase - Specifies whether the path is case-sensitive.
- methods List<String>
- The request method.
- paths List<Property Map>
- The path rule.
- query
Params List<Property Map> - The matching rules for query parameters.
GetRoutesRouteMatchHeader
GetRoutesRouteMatchPath
GetRoutesRouteMatchQueryParam
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
published on Thursday, Sep 17, 2026 by Pulumi