1. Packages
  2. Volcengine
  3. API Docs
  4. apig
  5. getCustomDomains
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.apig.getCustomDomains

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of apig custom domains

    Example Usage

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

const foo = volcengine.apig.getCustomDomains({
    gatewayId: "gd13d8c6eq1emkiunq6p0",
    serviceId: "sd142lm6kiaj519k4l640",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.apig.get_custom_domains(gateway_id="gd13d8c6eq1emkiunq6p0",
    service_id="sd142lm6kiaj519k4l640")

    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.GetCustomDomains(ctx, &apig.GetCustomDomainsArgs{
			GatewayId: pulumi.StringRef("gd13d8c6eq1emkiunq6p0"),
			ServiceId: pulumi.StringRef("sd142lm6kiaj519k4l640"),
		}, 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.GetCustomDomains.Invoke(new()
    {
        GatewayId = "gd13d8c6eq1emkiunq6p0",
        ServiceId = "sd142lm6kiaj519k4l640",
    });

});

    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.GetCustomDomainsArgs;
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.getCustomDomains(GetCustomDomainsArgs.builder()
            .gatewayId("gd13d8c6eq1emkiunq6p0")
            .serviceId("sd142lm6kiaj519k4l640")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:apig:getCustomDomains
      Arguments:
        gatewayId: gd13d8c6eq1emkiunq6p0
        serviceId: sd142lm6kiaj519k4l640

    Using getCustomDomains

    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 getCustomDomains(args: GetCustomDomainsArgs, opts?: InvokeOptions): Promise<GetCustomDomainsResult>
function getCustomDomainsOutput(args: GetCustomDomainsOutputArgs, opts?: InvokeOptions): Output<GetCustomDomainsResult>
    def get_custom_domains(gateway_id: Optional[str] = None,
                       name_regex: Optional[str] = None,
                       output_file: Optional[str] = None,
                       resource_type: Optional[str] = None,
                       service_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCustomDomainsResult
def get_custom_domains_output(gateway_id: Optional[pulumi.Input[str]] = None,
                       name_regex: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[pulumi.Input[str]] = None,
                       resource_type: Optional[pulumi.Input[str]] = None,
                       service_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCustomDomainsResult]
    func GetCustomDomains(ctx *Context, args *GetCustomDomainsArgs, opts ...InvokeOption) (*GetCustomDomainsResult, error)
func GetCustomDomainsOutput(ctx *Context, args *GetCustomDomainsOutputArgs, opts ...InvokeOption) GetCustomDomainsResultOutput

    > Note: This function is named GetCustomDomains in the Go SDK.

    public static class GetCustomDomains 
{
    public static Task<GetCustomDomainsResult> InvokeAsync(GetCustomDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomDomainsResult> Invoke(GetCustomDomainsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomDomainsResult> getCustomDomains(GetCustomDomainsArgs args, InvokeOptions options)
public static Output<GetCustomDomainsResult> getCustomDomains(GetCustomDomainsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    GatewayId string
    The id of api gateway.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    ServiceId string
    The id of api gateway service.
    GatewayId string
    The id of api gateway.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    ServiceId string
    The id of api gateway service.
    gatewayId String
    The id of api gateway.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    serviceId String
    The id of api gateway service.
    gatewayId string
    The id of api gateway.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    resourceType string
    The resource type of domain. Valid values: Console, Ingress.
    serviceId string
    The id of api gateway service.
    gateway_id str
    The id of api gateway.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    resource_type str
    The resource type of domain. Valid values: Console, Ingress.
    service_id str
    The id of api gateway service.
    gatewayId String
    The id of api gateway.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    serviceId String
    The id of api gateway service.

    getCustomDomains Result

    The following output properties are available:

    CustomDomains List<GetCustomDomainsCustomDomain>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    GatewayId string
    NameRegex string
    OutputFile string
    ResourceType string
    The resource type of domain.
    ServiceId string
    The id of the api gateway service.
    CustomDomains []GetCustomDomainsCustomDomain
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    GatewayId string
    NameRegex string
    OutputFile string
    ResourceType string
    The resource type of domain.
    ServiceId string
    The id of the api gateway service.
    customDomains List<GetCustomDomainsCustomDomain>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    gatewayId String
    nameRegex String
    outputFile String
    resourceType String
    The resource type of domain.
    serviceId String
    The id of the api gateway service.
    customDomains GetCustomDomainsCustomDomain[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    gatewayId string
    nameRegex string
    outputFile string
    resourceType string
    The resource type of domain.
    serviceId string
    The id of the api gateway service.
    custom_domains Sequence[GetCustomDomainsCustomDomain]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    gateway_id str
    name_regex str
    output_file str
    resource_type str
    The resource type of domain.
    service_id str
    The id of the api gateway service.
    customDomains List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    gatewayId String
    nameRegex String
    outputFile String
    resourceType String
    The resource type of domain.
    serviceId String
    The id of the api gateway service.

    Supporting Types

    GetCustomDomainsCustomDomain

    CertificateId string
    The id of the certificate.
    Comments string
    The comments of the custom domain.
    CreateTime string
    The create time of the custom domain.
    Domain string
    The custom domain of the api gateway service.
    Id string
    The id of the custom domain.
    Protocols List<string>
    The protocol of the custom domain.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    ServiceId string
    The id of api gateway service.
    SslRedirect bool
    Whether to redirect https.
    Status string
    The status of the custom domain.
    Type string
    The type of the domain.
    UpdateTime string
    The update time of the custom domain.
    CertificateId string
    The id of the certificate.
    Comments string
    The comments of the custom domain.
    CreateTime string
    The create time of the custom domain.
    Domain string
    The custom domain of the api gateway service.
    Id string
    The id of the custom domain.
    Protocols []string
    The protocol of the custom domain.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    ServiceId string
    The id of api gateway service.
    SslRedirect bool
    Whether to redirect https.
    Status string
    The status of the custom domain.
    Type string
    The type of the domain.
    UpdateTime string
    The update time of the custom domain.
    certificateId String
    The id of the certificate.
    comments String
    The comments of the custom domain.
    createTime String
    The create time of the custom domain.
    domain String
    The custom domain of the api gateway service.
    id String
    The id of the custom domain.
    protocols List<String>
    The protocol of the custom domain.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    serviceId String
    The id of api gateway service.
    sslRedirect Boolean
    Whether to redirect https.
    status String
    The status of the custom domain.
    type String
    The type of the domain.
    updateTime String
    The update time of the custom domain.
    certificateId string
    The id of the certificate.
    comments string
    The comments of the custom domain.
    createTime string
    The create time of the custom domain.
    domain string
    The custom domain of the api gateway service.
    id string
    The id of the custom domain.
    protocols string[]
    The protocol of the custom domain.
    resourceType string
    The resource type of domain. Valid values: Console, Ingress.
    serviceId string
    The id of api gateway service.
    sslRedirect boolean
    Whether to redirect https.
    status string
    The status of the custom domain.
    type string
    The type of the domain.
    updateTime string
    The update time of the custom domain.
    certificate_id str
    The id of the certificate.
    comments str
    The comments of the custom domain.
    create_time str
    The create time of the custom domain.
    domain str
    The custom domain of the api gateway service.
    id str
    The id of the custom domain.
    protocols Sequence[str]
    The protocol of the custom domain.
    resource_type str
    The resource type of domain. Valid values: Console, Ingress.
    service_id str
    The id of api gateway service.
    ssl_redirect bool
    Whether to redirect https.
    status str
    The status of the custom domain.
    type str
    The type of the domain.
    update_time str
    The update time of the custom domain.
    certificateId String
    The id of the certificate.
    comments String
    The comments of the custom domain.
    createTime String
    The create time of the custom domain.
    domain String
    The custom domain of the api gateway service.
    id String
    The id of the custom domain.
    protocols List<String>
    The protocol of the custom domain.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    serviceId String
    The id of api gateway service.
    sslRedirect Boolean
    Whether to redirect https.
    status String
    The status of the custom domain.
    type String
    The type of the domain.
    updateTime String
    The update time of the custom domain.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate