Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine.apig.Routes
Explore with Pulumi AI
Deprecated: volcengine.apig.Routes has been deprecated in favor of volcengine.apig.getRoutes
Use this data source to query detailed information of apig routes
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
const foo = volcengine.apig.getRoutes({
gatewayId: "gd1ek1ki9optek6ooabh0",
});
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.apig.get_routes(gateway_id="gd1ek1ki9optek6ooabh0")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/apig"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apig.GetRoutes(ctx, &apig.GetRoutesArgs{
GatewayId: pulumi.StringRef("gd1ek1ki9optek6ooabh0"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = Volcengine.Apig.GetRoutes.Invoke(new()
{
GatewayId = "gd1ek1ki9optek6ooabh0",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.apig.ApigFunctions;
import com.pulumi.volcengine.apig.inputs.GetRoutesArgs;
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) {
final var foo = ApigFunctions.getRoutes(GetRoutesArgs.builder()
.gatewayId("gd1ek1ki9optek6ooabh0")
.build());
}
}
variables:
foo:
fn::invoke:
Function: volcengine:apig:getRoutes
Arguments:
gatewayId: gd1ek1ki9optek6ooabh0
Using Routes
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 routes(args: RoutesArgs, opts?: InvokeOptions): Promise<RoutesResult>
function routesOutput(args: RoutesOutputArgs, opts?: InvokeOptions): Output<RoutesResult>
def routes(gateway_id: Optional[str] = None,
name: Optional[str] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
path: Optional[str] = None,
resource_type: Optional[str] = None,
service_id: Optional[str] = None,
upstream_id: Optional[str] = None,
upstream_version: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> RoutesResult
def routes_output(gateway_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
path: Optional[pulumi.Input[str]] = None,
resource_type: Optional[pulumi.Input[str]] = None,
service_id: Optional[pulumi.Input[str]] = None,
upstream_id: Optional[pulumi.Input[str]] = None,
upstream_version: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[RoutesResult]
func Routes(ctx *Context, args *RoutesArgs, opts ...InvokeOption) (*RoutesResult, error)
func RoutesOutput(ctx *Context, args *RoutesOutputArgs, opts ...InvokeOption) RoutesResultOutput
public static class Routes
{
public static Task<RoutesResult> InvokeAsync(RoutesArgs args, InvokeOptions? opts = null)
public static Output<RoutesResult> Invoke(RoutesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<RoutesResult> routes(RoutesArgs args, InvokeOptions options)
public static Output<RoutesResult> routes(RoutesArgs args, InvokeOptions options)
fn::invoke:
function: volcengine:apig:Routes
arguments:
# arguments dictionary
The following arguments are supported:
- Gateway
Id string - The id of api gateway.
- Name string
- The name of api gateway route. This field support fuzzy query.
- Name
Regex string - A Name Regex of Resource.
- Output
File string - File name where to save data source results.
- Path string
- The path of api gateway route.
- Resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - Service
Id string - The id of api gateway service.
- Upstream
Id string - The id of api gateway upstream.
- Upstream
Version string - The version of api gateway upstream.
- Gateway
Id string - The id of api gateway.
- Name string
- The name of api gateway route. This field support fuzzy query.
- Name
Regex string - A Name Regex of Resource.
- Output
File string - File name where to save data source results.
- Path string
- The path of api gateway route.
- Resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - Service
Id string - The id of api gateway service.
- Upstream
Id string - The id of api gateway upstream.
- Upstream
Version string - The version of api gateway upstream.
- gateway
Id String - The id of api gateway.
- name String
- The name of api gateway route. This field support fuzzy query.
- name
Regex String - A Name Regex of Resource.
- output
File String - File name where to save data source results.
- path String
- The path of api gateway route.
- resource
Type String - The resource type of route. Valid values:
Console
,Ingress
. - service
Id String - The id of api gateway service.
- upstream
Id String - The id of api gateway upstream.
- upstream
Version String - The version of api gateway upstream.
- gateway
Id string - The id of api gateway.
- name string
- The name of api gateway route. This field support fuzzy query.
- name
Regex string - A Name Regex of Resource.
- output
File string - File name where to save data source results.
- path string
- The path of api gateway route.
- resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - service
Id string - The id of api gateway service.
- upstream
Id string - The id of api gateway upstream.
- upstream
Version string - The version of api gateway upstream.
- gateway_
id str - The id of api gateway.
- name str
- The name of api gateway route. This field support fuzzy query.
- name_
regex str - A Name Regex of Resource.
- output_
file str - File name where to save data source results.
- path str
- The path of api gateway route.
- resource_
type str - The resource type of route. Valid values:
Console
,Ingress
. - service_
id str - The id of api gateway service.
- upstream_
id str - The id of api gateway upstream.
- upstream_
version str - The version of api gateway upstream.
- gateway
Id String - The id of api gateway.
- name String
- The name of api gateway route. This field support fuzzy query.
- name
Regex String - A Name Regex of Resource.
- output
File String - File name where to save data source results.
- path String
- The path of api gateway route.
- resource
Type String - The resource type of route. Valid values:
Console
,Ingress
. - service
Id String - The id of api gateway service.
- upstream
Id String - The id of api gateway upstream.
- upstream
Version String - The version of api gateway upstream.
Routes Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Routes
List<Routes
Route> - The collection of query.
- Total
Count int - The total count of query.
- Gateway
Id string - Name string
- The name of the api gateway route.
- Name
Regex string - Output
File string - Path string
- The path of the api gateway route.
- Resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - Service
Id string - The id of the api gateway service.
- Upstream
Id string - The id of the api gateway upstream.
- Upstream
Version string
- Id string
- The provider-assigned unique ID for this managed resource.
- Routes
[]Routes
Route - The collection of query.
- Total
Count int - The total count of query.
- Gateway
Id string - Name string
- The name of the api gateway route.
- Name
Regex string - Output
File string - Path string
- The path of the api gateway route.
- Resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - Service
Id string - The id of the api gateway service.
- Upstream
Id string - The id of the api gateway upstream.
- Upstream
Version string
- id String
- The provider-assigned unique ID for this managed resource.
- routes
List<Routes
Route> - The collection of query.
- total
Count Integer - The total count of query.
- gateway
Id String - name String
- The name of the api gateway route.
- name
Regex String - output
File String - path String
- The path of the api gateway route.
- resource
Type String - The resource type of route. Valid values:
Console
,Ingress
. - service
Id String - The id of the api gateway service.
- upstream
Id String - The id of the api gateway upstream.
- upstream
Version String
- id string
- The provider-assigned unique ID for this managed resource.
- routes
Routes
Route[] - The collection of query.
- total
Count number - The total count of query.
- gateway
Id string - name string
- The name of the api gateway route.
- name
Regex string - output
File string - path string
- The path of the api gateway route.
- resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - service
Id string - The id of the api gateway service.
- upstream
Id string - The id of the api gateway upstream.
- upstream
Version string
- id str
- The provider-assigned unique ID for this managed resource.
- routes
Sequence[Routes
Route] - The collection of query.
- total_
count int - The total count of query.
- gateway_
id str - name str
- The name of the api gateway route.
- name_
regex str - output_
file str - path str
- The path of the api gateway route.
- resource_
type str - The resource type of route. Valid values:
Console
,Ingress
. - service_
id str - The id of the api gateway service.
- upstream_
id str - The id of the api gateway upstream.
- upstream_
version str
- id String
- The provider-assigned unique ID for this managed resource.
- routes List<Property Map>
- The collection of query.
- total
Count Number - The total count of query.
- gateway
Id String - name String
- The name of the api gateway route.
- name
Regex String - output
File String - path String
- The path of the api gateway route.
- resource
Type String - The resource type of route. Valid values:
Console
,Ingress
. - service
Id String - The id of the api gateway service.
- upstream
Id String - The id of the api gateway upstream.
- upstream
Version String
Supporting Types
RoutesRoute
- Advanced
Settings List<RoutesRoute Advanced Setting> - The advanced setting of the api gateway route.
- Create
Time string - The create time of the api gateway route.
- Custom
Domains List<RoutesRoute Custom Domain> - The custom domains of the api gateway route.
- Domains
List<Routes
Route Domain> - The domains of the api gateway route.
- Enable bool
- Whether the api gateway route is enabled.
- Id string
- The id of the api gateway route.
- Match
Rules List<RoutesRoute Match Rule> - The match rule of the api gateway route.
- Name string
- The name of api gateway route. This field support fuzzy query.
- Priority int
- The priority of the api gateway route.
- Reason string
- The reason of the api gateway route.
- Resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - Service
Id string - The id of api gateway service.
- Service
Name string - The name of the api gateway service.
- Status string
- The status of the api gateway route.
- Update
Time string - The update time of the api gateway route.
- Upstream
Lists List<RoutesRoute Upstream List> - The upstream list of the api gateway route.
- Advanced
Settings []RoutesRoute Advanced Setting - The advanced setting of the api gateway route.
- Create
Time string - The create time of the api gateway route.
- Custom
Domains []RoutesRoute Custom Domain - The custom domains of the api gateway route.
- Domains
[]Routes
Route Domain - The domains of the api gateway route.
- Enable bool
- Whether the api gateway route is enabled.
- Id string
- The id of the api gateway route.
- Match
Rules []RoutesRoute Match Rule - The match rule of the api gateway route.
- Name string
- The name of api gateway route. This field support fuzzy query.
- Priority int
- The priority of the api gateway route.
- Reason string
- The reason of the api gateway route.
- Resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - Service
Id string - The id of api gateway service.
- Service
Name string - The name of the api gateway service.
- Status string
- The status of the api gateway route.
- Update
Time string - The update time of the api gateway route.
- Upstream
Lists []RoutesRoute Upstream List - The upstream list of the api gateway route.
- advanced
Settings List<RoutesRoute Advanced Setting> - The advanced setting of the api gateway route.
- create
Time String - The create time of the api gateway route.
- custom
Domains List<RoutesRoute Custom Domain> - The custom domains of the api gateway route.
- domains
List<Routes
Route Domain> - The domains of the api gateway route.
- enable Boolean
- Whether the api gateway route is enabled.
- id String
- The id of the api gateway route.
- match
Rules List<RoutesRoute Match Rule> - The match rule of the api gateway route.
- name String
- The name of api gateway route. This field support fuzzy query.
- priority Integer
- The priority of the api gateway route.
- reason String
- The reason of the api gateway route.
- resource
Type String - The resource type of route. Valid values:
Console
,Ingress
. - service
Id String - The id of api gateway service.
- service
Name String - The name of the api gateway service.
- status String
- The status of the api gateway route.
- update
Time String - The update time of the api gateway route.
- upstream
Lists List<RoutesRoute Upstream List> - The upstream list of the api gateway route.
- advanced
Settings RoutesRoute Advanced Setting[] - The advanced setting of the api gateway route.
- create
Time string - The create time of the api gateway route.
- custom
Domains RoutesRoute Custom Domain[] - The custom domains of the api gateway route.
- domains
Routes
Route Domain[] - The domains of the api gateway route.
- enable boolean
- Whether the api gateway route is enabled.
- id string
- The id of the api gateway route.
- match
Rules RoutesRoute Match Rule[] - The match rule of the api gateway route.
- name string
- The name of api gateway route. This field support fuzzy query.
- priority number
- The priority of the api gateway route.
- reason string
- The reason of the api gateway route.
- resource
Type string - The resource type of route. Valid values:
Console
,Ingress
. - service
Id string - The id of api gateway service.
- service
Name string - The name of the api gateway service.
- status string
- The status of the api gateway route.
- update
Time string - The update time of the api gateway route.
- upstream
Lists RoutesRoute Upstream List[] - The upstream list of the api gateway route.
- advanced_
settings Sequence[RoutesRoute Advanced Setting] - The advanced setting of the api gateway route.
- create_
time str - The create time of the api gateway route.
- custom_
domains Sequence[RoutesRoute Custom Domain] - The custom domains of the api gateway route.
- domains
Sequence[Routes
Route Domain] - The domains of the api gateway route.
- enable bool
- Whether the api gateway route is enabled.
- id str
- The id of the api gateway route.
- match_
rules Sequence[RoutesRoute Match Rule] - The match rule of the api gateway route.
- name str
- The name of api gateway route. This field support fuzzy query.
- priority int
- The priority of the api gateway route.
- reason str
- The reason of the api gateway route.
- resource_
type str - The resource type of route. Valid values:
Console
,Ingress
. - service_
id str - The id of api gateway service.
- service_
name str - The name of the api gateway service.
- status str
- The status of the api gateway route.
- update_
time str - The update time of the api gateway route.
- upstream_
lists Sequence[RoutesRoute Upstream List] - The upstream list of the api gateway route.
- advanced
Settings List<Property Map> - The advanced setting of the api gateway route.
- create
Time String - The create time of the api gateway route.
- custom
Domains List<Property Map> - The custom domains of the api gateway route.
- domains List<Property Map>
- The domains of the api gateway route.
- enable Boolean
- Whether the api gateway route is enabled.
- id String
- The id of the api gateway route.
- match
Rules List<Property Map> - The match rule of the api gateway route.
- name String
- The name of api gateway route. This field support fuzzy query.
- priority Number
- The priority of the api gateway route.
- reason String
- The reason of the api gateway route.
- resource
Type String - The resource type of route. Valid values:
Console
,Ingress
. - service
Id String - The id of api gateway service.
- service
Name String - The name of the api gateway service.
- status String
- The status of the api gateway route.
- update
Time String - The update time of the api gateway route.
- upstream
Lists List<Property Map> - The upstream list of the api gateway route.
RoutesRouteAdvancedSetting
- Cors
Policy List<RoutesSettings Route Advanced Setting Cors Policy Setting> - The cors policy setting of the api gateway route.
- Header
Operations List<RoutesRoute Advanced Setting Header Operation> - The header operations of the api gateway route.
- Mirror
Policies List<RoutesRoute Advanced Setting Mirror Policy> - The mirror policies of the api gateway route.
- Retry
Policy List<RoutesSettings Route Advanced Setting Retry Policy Setting> - The retry policy setting of the api gateway route.
- Timeout
Settings List<RoutesRoute Advanced Setting Timeout Setting> - The timeout setting of the api gateway route.
- Url
Rewrite List<RoutesSettings Route Advanced Setting Url Rewrite Setting> - The url rewrite setting of the api gateway route.
- Cors
Policy []RoutesSettings Route Advanced Setting Cors Policy Setting - The cors policy setting of the api gateway route.
- Header
Operations []RoutesRoute Advanced Setting Header Operation - The header operations of the api gateway route.
- Mirror
Policies []RoutesRoute Advanced Setting Mirror Policy - The mirror policies of the api gateway route.
- Retry
Policy []RoutesSettings Route Advanced Setting Retry Policy Setting - The retry policy setting of the api gateway route.
- Timeout
Settings []RoutesRoute Advanced Setting Timeout Setting - The timeout setting of the api gateway route.
- Url
Rewrite []RoutesSettings Route Advanced Setting Url Rewrite Setting - The url rewrite setting of the api gateway route.
- cors
Policy List<RoutesSettings Route Advanced Setting Cors Policy Setting> - The cors policy setting of the api gateway route.
- header
Operations List<RoutesRoute Advanced Setting Header Operation> - The header operations of the api gateway route.
- mirror
Policies List<RoutesRoute Advanced Setting Mirror Policy> - The mirror policies of the api gateway route.
- retry
Policy List<RoutesSettings Route Advanced Setting Retry Policy Setting> - The retry policy setting of the api gateway route.
- timeout
Settings List<RoutesRoute Advanced Setting Timeout Setting> - The timeout setting of the api gateway route.
- url
Rewrite List<RoutesSettings Route Advanced Setting Url Rewrite Setting> - The url rewrite setting of the api gateway route.
- cors
Policy RoutesSettings Route Advanced Setting Cors Policy Setting[] - The cors policy setting of the api gateway route.
- header
Operations RoutesRoute Advanced Setting Header Operation[] - The header operations of the api gateway route.
- mirror
Policies RoutesRoute Advanced Setting Mirror Policy[] - The mirror policies of the api gateway route.
- retry
Policy RoutesSettings Route Advanced Setting Retry Policy Setting[] - The retry policy setting of the api gateway route.
- timeout
Settings RoutesRoute Advanced Setting Timeout Setting[] - The timeout setting of the api gateway route.
- url
Rewrite RoutesSettings Route Advanced Setting Url Rewrite Setting[] - The url rewrite setting of the api gateway route.
- cors_
policy_ Sequence[Routessettings Route Advanced Setting Cors Policy Setting] - The cors policy setting of the api gateway route.
- header_
operations Sequence[RoutesRoute Advanced Setting Header Operation] - The header operations of the api gateway route.
- mirror_
policies Sequence[RoutesRoute Advanced Setting Mirror Policy] - The mirror policies of the api gateway route.
- retry_
policy_ Sequence[Routessettings Route Advanced Setting Retry Policy Setting] - The retry policy setting of the api gateway route.
- timeout_
settings Sequence[RoutesRoute Advanced Setting Timeout Setting] - The timeout setting of the api gateway route.
- url_
rewrite_ Sequence[Routessettings Route Advanced Setting Url Rewrite Setting] - The url rewrite setting of the api gateway route.
- cors
Policy List<Property Map>Settings - The cors policy setting of the api gateway route.
- header
Operations List<Property Map> - The header operations of the api gateway route.
- mirror
Policies List<Property Map> - The mirror policies of the api gateway route.
- retry
Policy List<Property Map>Settings - The retry policy setting of the api gateway route.
- timeout
Settings List<Property Map> - The timeout setting of the api gateway route.
- url
Rewrite List<Property Map>Settings - The url rewrite setting of the api gateway route.
RoutesRouteAdvancedSettingCorsPolicySetting
- Enable bool
- Whether the api gateway route is enabled.
- Enable bool
- Whether the api gateway route is enabled.
- enable Boolean
- Whether the api gateway route is enabled.
- enable boolean
- Whether the api gateway route is enabled.
- enable bool
- Whether the api gateway route is enabled.
- enable Boolean
- Whether the api gateway route is enabled.
RoutesRouteAdvancedSettingHeaderOperation
- Direction
Type string - The direction type of the header.
- Key string
- The key of the query string.
- Operation string
- The operation of the header.
- Value string
- The path of the api gateway route.
- Direction
Type string - The direction type of the header.
- Key string
- The key of the query string.
- Operation string
- The operation of the header.
- Value string
- The path of the api gateway route.
- direction
Type String - The direction type of the header.
- key String
- The key of the query string.
- operation String
- The operation of the header.
- value String
- The path of the api gateway route.
- direction
Type string - The direction type of the header.
- key string
- The key of the query string.
- operation string
- The operation of the header.
- value string
- The path of the api gateway route.
- direction_
type str - The direction type of the header.
- key str
- The key of the query string.
- operation str
- The operation of the header.
- value str
- The path of the api gateway route.
- direction
Type String - The direction type of the header.
- key String
- The key of the query string.
- operation String
- The operation of the header.
- value String
- The path of the api gateway route.
RoutesRouteAdvancedSettingMirrorPolicy
- Percents
List<Routes
Route Advanced Setting Mirror Policy Percent> - The percent of the mirror policy.
- Upstreams
List<Routes
Route Advanced Setting Mirror Policy Upstream> - The upstream of the mirror policy.
- Percents
[]Routes
Route Advanced Setting Mirror Policy Percent - The percent of the mirror policy.
- Upstreams
[]Routes
Route Advanced Setting Mirror Policy Upstream - The upstream of the mirror policy.
- percents
List<Routes
Route Advanced Setting Mirror Policy Percent> - The percent of the mirror policy.
- upstreams
List<Routes
Route Advanced Setting Mirror Policy Upstream> - The upstream of the mirror policy.
- percents
Routes
Route Advanced Setting Mirror Policy Percent[] - The percent of the mirror policy.
- upstreams
Routes
Route Advanced Setting Mirror Policy Upstream[] - The upstream of the mirror policy.
- percents
Sequence[Routes
Route Advanced Setting Mirror Policy Percent] - The percent of the mirror policy.
- upstreams
Sequence[Routes
Route Advanced Setting Mirror Policy Upstream] - The upstream of the mirror policy.
- percents List<Property Map>
- The percent of the mirror policy.
- upstreams List<Property Map>
- The upstream of the mirror policy.
RoutesRouteAdvancedSettingMirrorPolicyPercent
- Value int
- The path of the api gateway route.
- Value int
- The path of the api gateway route.
- value Integer
- The path of the api gateway route.
- value number
- The path of the api gateway route.
- value int
- The path of the api gateway route.
- value Number
- The path of the api gateway route.
RoutesRouteAdvancedSettingMirrorPolicyUpstream
- Type string
- The type of the domain.
- Upstream
Id string - The id of api gateway upstream.
- Version string
- The version of the api gateway upstream.
- Type string
- The type of the domain.
- Upstream
Id string - The id of api gateway upstream.
- Version string
- The version of the api gateway upstream.
- type String
- The type of the domain.
- upstream
Id String - The id of api gateway upstream.
- version String
- The version of the api gateway upstream.
- type string
- The type of the domain.
- upstream
Id string - The id of api gateway upstream.
- version string
- The version of the api gateway upstream.
- type str
- The type of the domain.
- upstream_
id str - The id of api gateway upstream.
- version str
- The version of the api gateway upstream.
- type String
- The type of the domain.
- upstream
Id String - The id of api gateway upstream.
- version String
- The version of the api gateway upstream.
RoutesRouteAdvancedSettingRetryPolicySetting
- Attempts int
- The attempts of the api gateway route.
- Enable bool
- Whether the api gateway route is enabled.
- Http
Codes List<string> - The http codes of the api gateway route.
- Per
Try intTimeout - The per try timeout of the api gateway route.
- Retry
Ons List<string> - The retry on of the api gateway route.
- Attempts int
- The attempts of the api gateway route.
- Enable bool
- Whether the api gateway route is enabled.
- Http
Codes []string - The http codes of the api gateway route.
- Per
Try intTimeout - The per try timeout of the api gateway route.
- Retry
Ons []string - The retry on of the api gateway route.
- attempts Integer
- The attempts of the api gateway route.
- enable Boolean
- Whether the api gateway route is enabled.
- http
Codes List<String> - The http codes of the api gateway route.
- per
Try IntegerTimeout - The per try timeout of the api gateway route.
- retry
Ons List<String> - The retry on of the api gateway route.
- attempts number
- The attempts of the api gateway route.
- enable boolean
- Whether the api gateway route is enabled.
- http
Codes string[] - The http codes of the api gateway route.
- per
Try numberTimeout - The per try timeout of the api gateway route.
- retry
Ons string[] - The retry on of the api gateway route.
- attempts int
- The attempts of the api gateway route.
- enable bool
- Whether the api gateway route is enabled.
- http_
codes Sequence[str] - The http codes of the api gateway route.
- per_
try_ inttimeout - The per try timeout of the api gateway route.
- retry_
ons Sequence[str] - The retry on of the api gateway route.
- attempts Number
- The attempts of the api gateway route.
- enable Boolean
- Whether the api gateway route is enabled.
- http
Codes List<String> - The http codes of the api gateway route.
- per
Try NumberTimeout - The per try timeout of the api gateway route.
- retry
Ons List<String> - The retry on of the api gateway route.
RoutesRouteAdvancedSettingTimeoutSetting
RoutesRouteAdvancedSettingUrlRewriteSetting
- Enable bool
- Whether the api gateway route is enabled.
- Url
Rewrite string - The url rewrite path of the api gateway route.
- Enable bool
- Whether the api gateway route is enabled.
- Url
Rewrite string - The url rewrite path of the api gateway route.
- enable Boolean
- Whether the api gateway route is enabled.
- url
Rewrite String - The url rewrite path of the api gateway route.
- enable boolean
- Whether the api gateway route is enabled.
- url
Rewrite string - The url rewrite path of the api gateway route.
- enable bool
- Whether the api gateway route is enabled.
- url_
rewrite str - The url rewrite path of the api gateway route.
- enable Boolean
- Whether the api gateway route is enabled.
- url
Rewrite String - The url rewrite path of the api gateway route.
RoutesRouteCustomDomain
RoutesRouteDomain
RoutesRouteMatchRule
- Headers
List<Routes
Route Match Rule Header> - The header of the api gateway route.
- Methods List<string>
- The method of the api gateway route.
- Paths
List<Routes
Route Match Rule Path> - The path of api gateway route.
- Query
Strings List<RoutesRoute Match Rule Query String> - The query string of the api gateway route.
- Headers
[]Routes
Route Match Rule Header - The header of the api gateway route.
- Methods []string
- The method of the api gateway route.
- Paths
[]Routes
Route Match Rule Path - The path of api gateway route.
- Query
Strings []RoutesRoute Match Rule Query String - The query string of the api gateway route.
- headers
List<Routes
Route Match Rule Header> - The header of the api gateway route.
- methods List<String>
- The method of the api gateway route.
- paths
List<Routes
Route Match Rule Path> - The path of api gateway route.
- query
Strings List<RoutesRoute Match Rule Query String> - The query string of the api gateway route.
- headers
Routes
Route Match Rule Header[] - The header of the api gateway route.
- methods string[]
- The method of the api gateway route.
- paths
Routes
Route Match Rule Path[] - The path of api gateway route.
- query
Strings RoutesRoute Match Rule Query String[] - The query string of the api gateway route.
- headers
Sequence[Routes
Route Match Rule Header] - The header of the api gateway route.
- methods Sequence[str]
- The method of the api gateway route.
- paths
Sequence[Routes
Route Match Rule Path] - The path of api gateway route.
- query_
strings Sequence[RoutesRoute Match Rule Query String] - The query string of the api gateway route.
- headers List<Property Map>
- The header of the api gateway route.
- methods List<String>
- The method of the api gateway route.
- paths List<Property Map>
- The path of api gateway route.
- query
Strings List<Property Map> - The query string of the api gateway route.
RoutesRouteMatchRuleHeader
- Key string
- The key of the query string.
- Values
List<Routes
Route Match Rule Header Value> - The path of the api gateway route.
- Key string
- The key of the query string.
- Values
[]Routes
Route Match Rule Header Value - The path of the api gateway route.
- key String
- The key of the query string.
- values
List<Routes
Route Match Rule Header Value> - The path of the api gateway route.
- key string
- The key of the query string.
- values
Routes
Route Match Rule Header Value[] - The path of the api gateway route.
- key str
- The key of the query string.
- values
Sequence[Routes
Route Match Rule Header Value] - The path of the api gateway route.
- key String
- The key of the query string.
- values List<Property Map>
- The path of the api gateway route.
RoutesRouteMatchRuleHeaderValue
- Match
Content string - The match content of the api gateway route.
- Match
Type string - The match type of the api gateway route.
- Match
Content string - The match content of the api gateway route.
- Match
Type string - The match type of the api gateway route.
- match
Content String - The match content of the api gateway route.
- match
Type String - The match type of the api gateway route.
- match
Content string - The match content of the api gateway route.
- match
Type string - The match type of the api gateway route.
- match_
content str - The match content of the api gateway route.
- match_
type str - The match type of the api gateway route.
- match
Content String - The match content of the api gateway route.
- match
Type String - The match type of the api gateway route.
RoutesRouteMatchRulePath
- Match
Content string - The match content of the api gateway route.
- Match
Type string - The match type of the api gateway route.
- Match
Content string - The match content of the api gateway route.
- Match
Type string - The match type of the api gateway route.
- match
Content String - The match content of the api gateway route.
- match
Type String - The match type of the api gateway route.
- match
Content string - The match content of the api gateway route.
- match
Type string - The match type of the api gateway route.
- match_
content str - The match content of the api gateway route.
- match_
type str - The match type of the api gateway route.
- match
Content String - The match content of the api gateway route.
- match
Type String - The match type of the api gateway route.
RoutesRouteMatchRuleQueryString
- Key string
- The key of the query string.
- Values
List<Routes
Route Match Rule Query String Value> - The path of the api gateway route.
- Key string
- The key of the query string.
- Values
[]Routes
Route Match Rule Query String Value - The path of the api gateway route.
- key String
- The key of the query string.
- values
List<Routes
Route Match Rule Query String Value> - The path of the api gateway route.
- key string
- The key of the query string.
- values
Routes
Route Match Rule Query String Value[] - The path of the api gateway route.
- key str
- The key of the query string.
- values
Sequence[Routes
Route Match Rule Query String Value] - The path of the api gateway route.
- key String
- The key of the query string.
- values List<Property Map>
- The path of the api gateway route.
RoutesRouteMatchRuleQueryStringValue
- Match
Content string - The match content of the api gateway route.
- Match
Type string - The match type of the api gateway route.
- Match
Content string - The match content of the api gateway route.
- Match
Type string - The match type of the api gateway route.
- match
Content String - The match content of the api gateway route.
- match
Type String - The match type of the api gateway route.
- match
Content string - The match content of the api gateway route.
- match
Type string - The match type of the api gateway route.
- match_
content str - The match content of the api gateway route.
- match_
type str - The match type of the api gateway route.
- match
Content String - The match content of the api gateway route.
- match
Type String - The match type of the api gateway route.
RoutesRouteUpstreamList
- Ai
Provider List<RoutesSettings Route Upstream List Ai Provider Setting> - The ai provider settings of the api gateway route.
- Upstream
Id string - The id of api gateway upstream.
- Version string
- The version of the api gateway upstream.
- Weight int
- The weight of the api gateway upstream.
- Ai
Provider []RoutesSettings Route Upstream List Ai Provider Setting - The ai provider settings of the api gateway route.
- Upstream
Id string - The id of api gateway upstream.
- Version string
- The version of the api gateway upstream.
- Weight int
- The weight of the api gateway upstream.
- ai
Provider List<RoutesSettings Route Upstream List Ai Provider Setting> - The ai provider settings of the api gateway route.
- upstream
Id String - The id of api gateway upstream.
- version String
- The version of the api gateway upstream.
- weight Integer
- The weight of the api gateway upstream.
- ai
Provider RoutesSettings Route Upstream List Ai Provider Setting[] - The ai provider settings of the api gateway route.
- upstream
Id string - The id of api gateway upstream.
- version string
- The version of the api gateway upstream.
- weight number
- The weight of the api gateway upstream.
- ai_
provider_ Sequence[Routessettings Route Upstream List Ai Provider Setting] - The ai provider settings of the api gateway route.
- upstream_
id str - The id of api gateway upstream.
- version str
- The version of the api gateway upstream.
- weight int
- The weight of the api gateway upstream.
- ai
Provider List<Property Map>Settings - The ai provider settings of the api gateway route.
- upstream
Id String - The id of api gateway upstream.
- version String
- The version of the api gateway upstream.
- weight Number
- The weight of the api gateway upstream.
RoutesRouteUpstreamListAiProviderSetting
- Model string
- The model of the ai provider.
- Target
Path string - The target path of the ai provider.
- Model string
- The model of the ai provider.
- Target
Path string - The target path of the ai provider.
- model String
- The model of the ai provider.
- target
Path String - The target path of the ai provider.
- model string
- The model of the ai provider.
- target
Path string - The target path of the ai provider.
- model str
- The model of the ai provider.
- target_
path str - The target path of the ai provider.
- model String
- The model of the ai provider.
- target
Path String - The target path of the ai provider.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.