getRoutes

Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

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 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?: InvokeOptions): Output<GetRoutesResult>

def get_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) -> GetRoutesResult
def get_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[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 CompletableFuture<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOptions options)
public static Output<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:apig/getRoutes:getRoutes
  arguments:
    # arguments dictionary

The following arguments are supported:

GatewayId string: The id of api gateway.
Name string: The name of api gateway route. This field support fuzzy query.
NameRegex string: A Name Regex of Resource.
OutputFile string: File name where to save data source results.
Path string: The path of api gateway route.
ResourceType string: The resource type of route. Valid values: Console, Ingress.
ServiceId string: The id of api gateway service.
UpstreamId string: The id of api gateway upstream.
UpstreamVersion string: The version of api gateway upstream.

GatewayId string: The id of api gateway.
Name string: The name of api gateway route. This field support fuzzy query.
NameRegex string: A Name Regex of Resource.
OutputFile string: File name where to save data source results.
Path string: The path of api gateway route.
ResourceType string: The resource type of route. Valid values: Console, Ingress.
ServiceId string: The id of api gateway service.
UpstreamId string: The id of api gateway upstream.
UpstreamVersion string: The version of api gateway upstream.

gatewayId String: The id of api gateway.
name String: The name of api gateway route. This field support fuzzy query.
nameRegex String: A Name Regex of Resource.
outputFile String: File name where to save data source results.
path String: The path of api gateway route.
resourceType String: The resource type of route. Valid values: Console, Ingress.
serviceId String: The id of api gateway service.
upstreamId String: The id of api gateway upstream.
upstreamVersion String: The version of api gateway upstream.

gatewayId string: The id of api gateway.
name string: The name of api gateway route. This field support fuzzy query.
nameRegex string: A Name Regex of Resource.
outputFile string: File name where to save data source results.
path string: The path of api gateway route.
resourceType string: The resource type of route. Valid values: Console, Ingress.
serviceId string: The id of api gateway service.
upstreamId string: The id of api gateway upstream.
upstreamVersion 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.

gatewayId String: The id of api gateway.
name String: The name of api gateway route. This field support fuzzy query.
nameRegex String: A Name Regex of Resource.
outputFile String: File name where to save data source results.
path String: The path of api gateway route.
resourceType String: The resource type of route. Valid values: Console, Ingress.
serviceId String: The id of api gateway service.
upstreamId String: The id of api gateway upstream.
upstreamVersion String: The version of api gateway upstream.

getRoutes Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Routes List<GetRoutesRoute>: The collection of query.
TotalCount int: The total count of query.
GatewayId string
Name string: The name of the api gateway route.
NameRegex string
OutputFile string
Path string: The path of the api gateway route.
ResourceType string: The resource type of route. Valid values: Console, Ingress.
ServiceId string: The id of the api gateway service.
UpstreamId string: The id of the api gateway upstream.
UpstreamVersion string

Id string: The provider-assigned unique ID for this managed resource.
Routes []GetRoutesRoute: The collection of query.
TotalCount int: The total count of query.
GatewayId string
Name string: The name of the api gateway route.
NameRegex string
OutputFile string
Path string: The path of the api gateway route.
ResourceType string: The resource type of route. Valid values: Console, Ingress.
ServiceId string: The id of the api gateway service.
UpstreamId string: The id of the api gateway upstream.
UpstreamVersion string

id String: The provider-assigned unique ID for this managed resource.
routes List<GetRoutesRoute>: The collection of query.
totalCount Integer: The total count of query.
gatewayId String
name String: The name of the api gateway route.
nameRegex String
outputFile String
path String: The path of the api gateway route.
resourceType String: The resource type of route. Valid values: Console, Ingress.
serviceId String: The id of the api gateway service.
upstreamId String: The id of the api gateway upstream.
upstreamVersion String

id string: The provider-assigned unique ID for this managed resource.
routes GetRoutesRoute[]: The collection of query.
totalCount number: The total count of query.
gatewayId string
name string: The name of the api gateway route.
nameRegex string
outputFile string
path string: The path of the api gateway route.
resourceType string: The resource type of route. Valid values: Console, Ingress.
serviceId string: The id of the api gateway service.
upstreamId string: The id of the api gateway upstream.
upstreamVersion string

id str: The provider-assigned unique ID for this managed resource.
routes Sequence[GetRoutesRoute]: 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.
totalCount Number: The total count of query.
gatewayId String
name String: The name of the api gateway route.
nameRegex String
outputFile String
path String: The path of the api gateway route.
resourceType String: The resource type of route. Valid values: Console, Ingress.
serviceId String: The id of the api gateway service.
upstreamId String: The id of the api gateway upstream.
upstreamVersion String

Supporting Types

GetRoutesRoute

AdvancedSettings List<GetRoutesRouteAdvancedSetting>: The advanced setting of the api gateway route.
CreateTime string: The create time of the api gateway route.
CustomDomains List<GetRoutesRouteCustomDomain>: The custom domains of the api gateway route.
Domains List<GetRoutesRouteDomain>: 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.
MatchRules List<GetRoutesRouteMatchRule>: 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.
ResourceType string: The resource type of route. Valid values: Console, Ingress.
ServiceId string: The id of api gateway service.
ServiceName string: The name of the api gateway service.
Status string: The status of the api gateway route.
UpdateTime string: The update time of the api gateway route.
UpstreamLists List<GetRoutesRouteUpstreamList>: The upstream list of the api gateway route.

AdvancedSettings []GetRoutesRouteAdvancedSetting: The advanced setting of the api gateway route.
CreateTime string: The create time of the api gateway route.
CustomDomains []GetRoutesRouteCustomDomain: The custom domains of the api gateway route.
Domains []GetRoutesRouteDomain: 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.
MatchRules []GetRoutesRouteMatchRule: 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.
ResourceType string: The resource type of route. Valid values: Console, Ingress.
ServiceId string: The id of api gateway service.
ServiceName string: The name of the api gateway service.
Status string: The status of the api gateway route.
UpdateTime string: The update time of the api gateway route.
UpstreamLists []GetRoutesRouteUpstreamList: The upstream list of the api gateway route.

advancedSettings List<GetRoutesRouteAdvancedSetting>: The advanced setting of the api gateway route.
createTime String: The create time of the api gateway route.
customDomains List<GetRoutesRouteCustomDomain>: The custom domains of the api gateway route.
domains List<GetRoutesRouteDomain>: 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.
matchRules List<GetRoutesRouteMatchRule>: 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.
resourceType String: The resource type of route. Valid values: Console, Ingress.
serviceId String: The id of api gateway service.
serviceName String: The name of the api gateway service.
status String: The status of the api gateway route.
updateTime String: The update time of the api gateway route.
upstreamLists List<GetRoutesRouteUpstreamList>: The upstream list of the api gateway route.

advancedSettings GetRoutesRouteAdvancedSetting[]: The advanced setting of the api gateway route.
createTime string: The create time of the api gateway route.
customDomains GetRoutesRouteCustomDomain[]: The custom domains of the api gateway route.
domains GetRoutesRouteDomain[]: 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.
matchRules GetRoutesRouteMatchRule[]: 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.
resourceType string: The resource type of route. Valid values: Console, Ingress.
serviceId string: The id of api gateway service.
serviceName string: The name of the api gateway service.
status string: The status of the api gateway route.
updateTime string: The update time of the api gateway route.
upstreamLists GetRoutesRouteUpstreamList[]: The upstream list of the api gateway route.

advanced_settings Sequence[GetRoutesRouteAdvancedSetting]: The advanced setting of the api gateway route.
create_time str: The create time of the api gateway route.
custom_domains Sequence[GetRoutesRouteCustomDomain]: The custom domains of the api gateway route.
domains Sequence[GetRoutesRouteDomain]: 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[GetRoutesRouteMatchRule]: 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[GetRoutesRouteUpstreamList]: The upstream list of the api gateway route.

advancedSettings List<Property Map>: The advanced setting of the api gateway route.
createTime String: The create time of the api gateway route.
customDomains 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.
matchRules 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.
resourceType String: The resource type of route. Valid values: Console, Ingress.
serviceId String: The id of api gateway service.
serviceName String: The name of the api gateway service.
status String: The status of the api gateway route.
updateTime String: The update time of the api gateway route.
upstreamLists List<Property Map>: The upstream list of the api gateway route.

GetRoutesRouteAdvancedSetting

CorsPolicySettings List<GetRoutesRouteAdvancedSettingCorsPolicySetting>: The cors policy setting of the api gateway route.
HeaderOperations List<GetRoutesRouteAdvancedSettingHeaderOperation>: The header operations of the api gateway route.
MirrorPolicies List<GetRoutesRouteAdvancedSettingMirrorPolicy>: The mirror policies of the api gateway route.
RetryPolicySettings List<GetRoutesRouteAdvancedSettingRetryPolicySetting>: The retry policy setting of the api gateway route.
TimeoutSettings List<GetRoutesRouteAdvancedSettingTimeoutSetting>: The timeout setting of the api gateway route.
UrlRewriteSettings List<GetRoutesRouteAdvancedSettingUrlRewriteSetting>: The url rewrite setting of the api gateway route.

CorsPolicySettings []GetRoutesRouteAdvancedSettingCorsPolicySetting: The cors policy setting of the api gateway route.
HeaderOperations []GetRoutesRouteAdvancedSettingHeaderOperation: The header operations of the api gateway route.
MirrorPolicies []GetRoutesRouteAdvancedSettingMirrorPolicy: The mirror policies of the api gateway route.
RetryPolicySettings []GetRoutesRouteAdvancedSettingRetryPolicySetting: The retry policy setting of the api gateway route.
TimeoutSettings []GetRoutesRouteAdvancedSettingTimeoutSetting: The timeout setting of the api gateway route.
UrlRewriteSettings []GetRoutesRouteAdvancedSettingUrlRewriteSetting: The url rewrite setting of the api gateway route.

corsPolicySettings List<GetRoutesRouteAdvancedSettingCorsPolicySetting>: The cors policy setting of the api gateway route.
headerOperations List<GetRoutesRouteAdvancedSettingHeaderOperation>: The header operations of the api gateway route.
mirrorPolicies List<GetRoutesRouteAdvancedSettingMirrorPolicy>: The mirror policies of the api gateway route.
retryPolicySettings List<GetRoutesRouteAdvancedSettingRetryPolicySetting>: The retry policy setting of the api gateway route.
timeoutSettings List<GetRoutesRouteAdvancedSettingTimeoutSetting>: The timeout setting of the api gateway route.
urlRewriteSettings List<GetRoutesRouteAdvancedSettingUrlRewriteSetting>: The url rewrite setting of the api gateway route.

corsPolicySettings GetRoutesRouteAdvancedSettingCorsPolicySetting[]: The cors policy setting of the api gateway route.
headerOperations GetRoutesRouteAdvancedSettingHeaderOperation[]: The header operations of the api gateway route.
mirrorPolicies GetRoutesRouteAdvancedSettingMirrorPolicy[]: The mirror policies of the api gateway route.
retryPolicySettings GetRoutesRouteAdvancedSettingRetryPolicySetting[]: The retry policy setting of the api gateway route.
timeoutSettings GetRoutesRouteAdvancedSettingTimeoutSetting[]: The timeout setting of the api gateway route.
urlRewriteSettings GetRoutesRouteAdvancedSettingUrlRewriteSetting[]: The url rewrite setting of the api gateway route.

cors_policy_settings Sequence[GetRoutesRouteAdvancedSettingCorsPolicySetting]: The cors policy setting of the api gateway route.
header_operations Sequence[GetRoutesRouteAdvancedSettingHeaderOperation]: The header operations of the api gateway route.
mirror_policies Sequence[GetRoutesRouteAdvancedSettingMirrorPolicy]: The mirror policies of the api gateway route.
retry_policy_settings Sequence[GetRoutesRouteAdvancedSettingRetryPolicySetting]: The retry policy setting of the api gateway route.
timeout_settings Sequence[GetRoutesRouteAdvancedSettingTimeoutSetting]: The timeout setting of the api gateway route.
url_rewrite_settings Sequence[GetRoutesRouteAdvancedSettingUrlRewriteSetting]: The url rewrite setting of the api gateway route.

corsPolicySettings List<Property Map>: The cors policy setting of the api gateway route.
headerOperations List<Property Map>: The header operations of the api gateway route.
mirrorPolicies List<Property Map>: The mirror policies of the api gateway route.
retryPolicySettings List<Property Map>: The retry policy setting of the api gateway route.
timeoutSettings List<Property Map>: The timeout setting of the api gateway route.
urlRewriteSettings List<Property Map>: The url rewrite setting of the api gateway route.

GetRoutesRouteAdvancedSettingCorsPolicySetting

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.

GetRoutesRouteAdvancedSettingHeaderOperation

DirectionType 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.

DirectionType 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.

directionType 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.

directionType 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.

directionType 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.

GetRoutesRouteAdvancedSettingMirrorPolicy

Percents List<GetRoutesRouteAdvancedSettingMirrorPolicyPercent>: The percent of the mirror policy.
Upstreams List<GetRoutesRouteAdvancedSettingMirrorPolicyUpstream>: The upstream of the mirror policy.

Percents []GetRoutesRouteAdvancedSettingMirrorPolicyPercent: The percent of the mirror policy.
Upstreams []GetRoutesRouteAdvancedSettingMirrorPolicyUpstream: The upstream of the mirror policy.

percents List<GetRoutesRouteAdvancedSettingMirrorPolicyPercent>: The percent of the mirror policy.
upstreams List<GetRoutesRouteAdvancedSettingMirrorPolicyUpstream>: The upstream of the mirror policy.

percents GetRoutesRouteAdvancedSettingMirrorPolicyPercent[]: The percent of the mirror policy.
upstreams GetRoutesRouteAdvancedSettingMirrorPolicyUpstream[]: The upstream of the mirror policy.

percents Sequence[GetRoutesRouteAdvancedSettingMirrorPolicyPercent]: The percent of the mirror policy.
upstreams Sequence[GetRoutesRouteAdvancedSettingMirrorPolicyUpstream]: 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.

GetRoutesRouteAdvancedSettingMirrorPolicyPercent

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.

GetRoutesRouteAdvancedSettingMirrorPolicyUpstream

Type string: The type of the domain.
UpstreamId string: The id of api gateway upstream.
Version string: The version of the api gateway upstream.

Type string: The type of the domain.
UpstreamId string: The id of api gateway upstream.
Version string: The version of the api gateway upstream.

type String: The type of the domain.
upstreamId String: The id of api gateway upstream.
version String: The version of the api gateway upstream.

type string: The type of the domain.
upstreamId 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.
upstreamId String: The id of api gateway upstream.
version String: The version of the api gateway upstream.

GetRoutesRouteAdvancedSettingRetryPolicySetting

Attempts int: The attempts of the api gateway route.
Enable bool: Whether the api gateway route is enabled.
HttpCodes List<string>: The http codes of the api gateway route.
PerTryTimeout int: The per try timeout of the api gateway route.
RetryOns 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.
HttpCodes []string: The http codes of the api gateway route.
PerTryTimeout int: The per try timeout of the api gateway route.
RetryOns []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.
httpCodes List<String>: The http codes of the api gateway route.
perTryTimeout Integer: The per try timeout of the api gateway route.
retryOns 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.
httpCodes string[]: The http codes of the api gateway route.
perTryTimeout number: The per try timeout of the api gateway route.
retryOns 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_timeout int: 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.
httpCodes List<String>: The http codes of the api gateway route.
perTryTimeout Number: The per try timeout of the api gateway route.
retryOns List<String>: The retry on of the api gateway route.

GetRoutesRouteAdvancedSettingTimeoutSetting

Enable bool: Whether the api gateway route is enabled.
Timeout int: The timeout of the api gateway route.

Enable bool: Whether the api gateway route is enabled.
Timeout int: The timeout of the api gateway route.

enable Boolean: Whether the api gateway route is enabled.
timeout Integer: The timeout of the api gateway route.

enable boolean: Whether the api gateway route is enabled.
timeout number: The timeout of the api gateway route.

enable bool: Whether the api gateway route is enabled.
timeout int: The timeout of the api gateway route.

enable Boolean: Whether the api gateway route is enabled.
timeout Number: The timeout of the api gateway route.

GetRoutesRouteAdvancedSettingUrlRewriteSetting

Enable bool: Whether the api gateway route is enabled.
UrlRewrite string: The url rewrite path of the api gateway route.

Enable bool: Whether the api gateway route is enabled.
UrlRewrite string: The url rewrite path of the api gateway route.

enable Boolean: Whether the api gateway route is enabled.
urlRewrite String: The url rewrite path of the api gateway route.

enable boolean: Whether the api gateway route is enabled.
urlRewrite 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.
urlRewrite String: The url rewrite path of the api gateway route.

GetRoutesRouteCustomDomain

Domain string: The domain of the api gateway route.
Id string: The id of the api gateway route.

Domain string: The domain of the api gateway route.
Id string: The id of the api gateway route.

domain String: The domain of the api gateway route.
id String: The id of the api gateway route.

domain string: The domain of the api gateway route.
id string: The id of the api gateway route.

domain str: The domain of the api gateway route.
id str: The id of the api gateway route.

domain String: The domain of the api gateway route.
id String: The id of the api gateway route.

GetRoutesRouteDomain

Domain string: The domain of the api gateway route.
Type string: The type of the domain.

Domain string: The domain of the api gateway route.
Type string: The type of the domain.

domain String: The domain of the api gateway route.
type String: The type of the domain.

domain string: The domain of the api gateway route.
type string: The type of the domain.

domain str: The domain of the api gateway route.
type str: The type of the domain.

domain String: The domain of the api gateway route.
type String: The type of the domain.

GetRoutesRouteMatchRule

Headers List<GetRoutesRouteMatchRuleHeader>: The header of the api gateway route.
Methods List<string>: The method of the api gateway route.
Paths List<GetRoutesRouteMatchRulePath>: The path of api gateway route.
QueryStrings List<GetRoutesRouteMatchRuleQueryString>: The query string of the api gateway route.

Headers []GetRoutesRouteMatchRuleHeader: The header of the api gateway route.
Methods []string: The method of the api gateway route.
Paths []GetRoutesRouteMatchRulePath: The path of api gateway route.
QueryStrings []GetRoutesRouteMatchRuleQueryString: The query string of the api gateway route.

headers List<GetRoutesRouteMatchRuleHeader>: The header of the api gateway route.
methods List<String>: The method of the api gateway route.
paths List<GetRoutesRouteMatchRulePath>: The path of api gateway route.
queryStrings List<GetRoutesRouteMatchRuleQueryString>: The query string of the api gateway route.

headers GetRoutesRouteMatchRuleHeader[]: The header of the api gateway route.
methods string[]: The method of the api gateway route.
paths GetRoutesRouteMatchRulePath[]: The path of api gateway route.
queryStrings GetRoutesRouteMatchRuleQueryString[]: The query string of the api gateway route.

headers Sequence[GetRoutesRouteMatchRuleHeader]: The header of the api gateway route.
methods Sequence[str]: The method of the api gateway route.
paths Sequence[GetRoutesRouteMatchRulePath]: The path of api gateway route.
query_strings Sequence[GetRoutesRouteMatchRuleQueryString]: 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.
queryStrings List<Property Map>: The query string of the api gateway route.

GetRoutesRouteMatchRuleHeader

Key string: The key of the query string.
Values List<GetRoutesRouteMatchRuleHeaderValue>: The path of the api gateway route.

Key string: The key of the query string.
Values []GetRoutesRouteMatchRuleHeaderValue: The path of the api gateway route.

key String: The key of the query string.
values List<GetRoutesRouteMatchRuleHeaderValue>: The path of the api gateway route.

key string: The key of the query string.
values GetRoutesRouteMatchRuleHeaderValue[]: The path of the api gateway route.

key str: The key of the query string.
values Sequence[GetRoutesRouteMatchRuleHeaderValue]: 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.

GetRoutesRouteMatchRuleHeaderValue

MatchContent string: The match content of the api gateway route.
MatchType string: The match type of the api gateway route.

MatchContent string: The match content of the api gateway route.
MatchType string: The match type of the api gateway route.

matchContent String: The match content of the api gateway route.
matchType String: The match type of the api gateway route.

matchContent string: The match content of the api gateway route.
matchType 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.

matchContent String: The match content of the api gateway route.
matchType String: The match type of the api gateway route.

GetRoutesRouteMatchRulePath

MatchContent string: The match content of the api gateway route.
MatchType string: The match type of the api gateway route.

MatchContent string: The match content of the api gateway route.
MatchType string: The match type of the api gateway route.

matchContent String: The match content of the api gateway route.
matchType String: The match type of the api gateway route.

matchContent string: The match content of the api gateway route.
matchType 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.

matchContent String: The match content of the api gateway route.
matchType String: The match type of the api gateway route.

GetRoutesRouteMatchRuleQueryString

Key string: The key of the query string.
Values List<GetRoutesRouteMatchRuleQueryStringValue>: The path of the api gateway route.

Key string: The key of the query string.
Values []GetRoutesRouteMatchRuleQueryStringValue: The path of the api gateway route.

key String: The key of the query string.
values List<GetRoutesRouteMatchRuleQueryStringValue>: The path of the api gateway route.

key string: The key of the query string.
values GetRoutesRouteMatchRuleQueryStringValue[]: The path of the api gateway route.

key str: The key of the query string.
values Sequence[GetRoutesRouteMatchRuleQueryStringValue]: 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.

GetRoutesRouteMatchRuleQueryStringValue

MatchContent string: The match content of the api gateway route.
MatchType string: The match type of the api gateway route.

MatchContent string: The match content of the api gateway route.
MatchType string: The match type of the api gateway route.

matchContent String: The match content of the api gateway route.
matchType String: The match type of the api gateway route.

matchContent string: The match content of the api gateway route.
matchType 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.

matchContent String: The match content of the api gateway route.
matchType String: The match type of the api gateway route.

GetRoutesRouteUpstreamList

AiProviderSettings List<GetRoutesRouteUpstreamListAiProviderSetting>: The ai provider settings of the api gateway route.
UpstreamId 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.

AiProviderSettings []GetRoutesRouteUpstreamListAiProviderSetting: The ai provider settings of the api gateway route.
UpstreamId 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.

aiProviderSettings List<GetRoutesRouteUpstreamListAiProviderSetting>: The ai provider settings of the api gateway route.
upstreamId 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.

aiProviderSettings GetRoutesRouteUpstreamListAiProviderSetting[]: The ai provider settings of the api gateway route.
upstreamId 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_settings Sequence[GetRoutesRouteUpstreamListAiProviderSetting]: 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.

aiProviderSettings List<Property Map>: The ai provider settings of the api gateway route.
upstreamId 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.

GetRoutesRouteUpstreamListAiProviderSetting

Model string: The model of the ai provider.
TargetPath string: The target path of the ai provider.

Model string: The model of the ai provider.
TargetPath string: The target path of the ai provider.

model String: The model of the ai provider.
targetPath String: The target path of the ai provider.

model string: The model of the ai provider.
targetPath 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.
targetPath 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.

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.apig.getRoutes

On this page

On this page

Example Usage

Using getRoutes

getRoutes Result

Supporting Types

GetRoutesRoute

GetRoutesRouteAdvancedSetting

GetRoutesRouteAdvancedSettingCorsPolicySetting

GetRoutesRouteAdvancedSettingHeaderOperation

GetRoutesRouteAdvancedSettingMirrorPolicy

GetRoutesRouteAdvancedSettingMirrorPolicyPercent

GetRoutesRouteAdvancedSettingMirrorPolicyUpstream

GetRoutesRouteAdvancedSettingRetryPolicySetting

GetRoutesRouteAdvancedSettingTimeoutSetting

GetRoutesRouteAdvancedSettingUrlRewriteSetting

GetRoutesRouteCustomDomain

GetRoutesRouteDomain

GetRoutesRouteMatchRule

GetRoutesRouteMatchRuleHeader

GetRoutesRouteMatchRuleHeaderValue

GetRoutesRouteMatchRulePath

GetRoutesRouteMatchRuleQueryString

GetRoutesRouteMatchRuleQueryStringValue

GetRoutesRouteUpstreamList

GetRoutesRouteUpstreamListAiProviderSetting

Package Details

On this page

On this page