1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getApiGatewayCustomerDomains
tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getApiGatewayCustomerDomains

Start a Neo task
Explain and create a tencentcloud.getApiGatewayCustomerDomains resource
tencentcloud logo
tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query API gateway domain list.

    Example Usage

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

const foo = new tencentcloud.ApiGatewayCustomDomain("foo", {
    serviceId: "service-ohxqslqe",
    subDomain: "tic-test.dnsv1.com",
    protocol: "http",
    netType: "OUTER",
    isDefaultMapping: false,
    defaultDomain: "service-ohxqslqe-1259649581.gz.apigw.tencentcs.com",
    pathMappings: [
        "/good#test",
        "/root#release",
    ],
});
const id = tencentcloud.getApiGatewayCustomerDomainsOutput({
    serviceId: foo.serviceId,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

foo = tencentcloud.ApiGatewayCustomDomain("foo",
    service_id="service-ohxqslqe",
    sub_domain="tic-test.dnsv1.com",
    protocol="http",
    net_type="OUTER",
    is_default_mapping=False,
    default_domain="service-ohxqslqe-1259649581.gz.apigw.tencentcs.com",
    path_mappings=[
        "/good#test",
        "/root#release",
    ])
id = tencentcloud.get_api_gateway_customer_domains_output(service_id=foo.service_id)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foo, err := tencentcloud.NewApiGatewayCustomDomain(ctx, "foo", &tencentcloud.ApiGatewayCustomDomainArgs{
			ServiceId:        pulumi.String("service-ohxqslqe"),
			SubDomain:        pulumi.String("tic-test.dnsv1.com"),
			Protocol:         pulumi.String("http"),
			NetType:          pulumi.String("OUTER"),
			IsDefaultMapping: pulumi.Bool(false),
			DefaultDomain:    pulumi.String("service-ohxqslqe-1259649581.gz.apigw.tencentcs.com"),
			PathMappings: pulumi.StringArray{
				pulumi.String("/good#test"),
				pulumi.String("/root#release"),
			},
		})
		if err != nil {
			return err
		}
		_ = tencentcloud.GetApiGatewayCustomerDomainsOutput(ctx, tencentcloud.GetApiGatewayCustomerDomainsOutputArgs{
			ServiceId: foo.ServiceId,
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var foo = new Tencentcloud.ApiGatewayCustomDomain("foo", new()
    {
        ServiceId = "service-ohxqslqe",
        SubDomain = "tic-test.dnsv1.com",
        Protocol = "http",
        NetType = "OUTER",
        IsDefaultMapping = false,
        DefaultDomain = "service-ohxqslqe-1259649581.gz.apigw.tencentcs.com",
        PathMappings = new[]
        {
            "/good#test",
            "/root#release",
        },
    });

    var id = Tencentcloud.GetApiGatewayCustomerDomains.Invoke(new()
    {
        ServiceId = foo.ServiceId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayCustomDomain;
import com.pulumi.tencentcloud.ApiGatewayCustomDomainArgs;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetApiGatewayCustomerDomainsArgs;
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) {
        var foo = new ApiGatewayCustomDomain("foo", ApiGatewayCustomDomainArgs.builder()
            .serviceId("service-ohxqslqe")
            .subDomain("tic-test.dnsv1.com")
            .protocol("http")
            .netType("OUTER")
            .isDefaultMapping(false)
            .defaultDomain("service-ohxqslqe-1259649581.gz.apigw.tencentcs.com")
            .pathMappings(            
                "/good#test",
                "/root#release")
            .build());

        final var id = TencentcloudFunctions.getApiGatewayCustomerDomains(GetApiGatewayCustomerDomainsArgs.builder()
            .serviceId(foo.serviceId())
            .build());

    }
}

    resources:
  foo:
    type: tencentcloud:ApiGatewayCustomDomain
    properties:
      serviceId: service-ohxqslqe
      subDomain: tic-test.dnsv1.com
      protocol: http
      netType: OUTER
      isDefaultMapping: 'false'
      defaultDomain: service-ohxqslqe-1259649581.gz.apigw.tencentcs.com
      pathMappings:
        - /good#test
        - /root#release
variables:
  id:
    fn::invoke:
      function: tencentcloud:getApiGatewayCustomerDomains
      arguments:
        serviceId: ${foo.serviceId}

    Using getApiGatewayCustomerDomains

    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 getApiGatewayCustomerDomains(args: GetApiGatewayCustomerDomainsArgs, opts?: InvokeOptions): Promise<GetApiGatewayCustomerDomainsResult>
function getApiGatewayCustomerDomainsOutput(args: GetApiGatewayCustomerDomainsOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayCustomerDomainsResult>
    def get_api_gateway_customer_domains(id: Optional[str] = None,
                                     result_output_file: Optional[str] = None,
                                     service_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetApiGatewayCustomerDomainsResult
def get_api_gateway_customer_domains_output(id: Optional[pulumi.Input[str]] = None,
                                     result_output_file: Optional[pulumi.Input[str]] = None,
                                     service_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayCustomerDomainsResult]
    func GetApiGatewayCustomerDomains(ctx *Context, args *GetApiGatewayCustomerDomainsArgs, opts ...InvokeOption) (*GetApiGatewayCustomerDomainsResult, error)
func GetApiGatewayCustomerDomainsOutput(ctx *Context, args *GetApiGatewayCustomerDomainsOutputArgs, opts ...InvokeOption) GetApiGatewayCustomerDomainsResultOutput

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

    public static class GetApiGatewayCustomerDomains 
{
    public static Task<GetApiGatewayCustomerDomainsResult> InvokeAsync(GetApiGatewayCustomerDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayCustomerDomainsResult> Invoke(GetApiGatewayCustomerDomainsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiGatewayCustomerDomainsResult> getApiGatewayCustomerDomains(GetApiGatewayCustomerDomainsArgs args, InvokeOptions options)
public static Output<GetApiGatewayCustomerDomainsResult> getApiGatewayCustomerDomains(GetApiGatewayCustomerDomainsArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getApiGatewayCustomerDomains:getApiGatewayCustomerDomains
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ServiceId string
    The service ID.
    Id string
    ResultOutputFile string
    Used to save results.
    ServiceId string
    The service ID.
    Id string
    ResultOutputFile string
    Used to save results.
    serviceId String
    The service ID.
    id String
    resultOutputFile String
    Used to save results.
    serviceId string
    The service ID.
    id string
    resultOutputFile string
    Used to save results.
    service_id str
    The service ID.
    id str
    result_output_file str
    Used to save results.
    serviceId String
    The service ID.
    id String
    resultOutputFile String
    Used to save results.

    getApiGatewayCustomerDomains Result

    The following output properties are available:

    Id string
    Lists List<GetApiGatewayCustomerDomainsList>
    Service custom domain name list.
    ServiceId string
    ResultOutputFile string
    Id string
    Lists []GetApiGatewayCustomerDomainsList
    Service custom domain name list.
    ServiceId string
    ResultOutputFile string
    id String
    lists List<GetApiGatewayCustomerDomainsList>
    Service custom domain name list.
    serviceId String
    resultOutputFile String
    id string
    lists GetApiGatewayCustomerDomainsList[]
    Service custom domain name list.
    serviceId string
    resultOutputFile string
    id String
    lists List<Property Map>
    Service custom domain name list.
    serviceId String
    resultOutputFile String

    Supporting Types

    GetApiGatewayCustomerDomainsList

    CertificateId string
    The certificate ID.
    DomainName string
    Domain name.
    IsDefaultMapping bool
    Whether to use default path mapping. Valid values: true, false. true means to use default path mapping, false means to use custom path mapping.
    IsStatusOn bool
    Domain name resolution status. Valid values: true, false. true means normal parsing, false means parsing failed.
    NetType string
    Network type.
    PathMappings List<GetApiGatewayCustomerDomainsListPathMapping>
    Domain name mapping path and environment list.
    Protocol string
    Custom domain name agreement type.
    CertificateId string
    The certificate ID.
    DomainName string
    Domain name.
    IsDefaultMapping bool
    Whether to use default path mapping. Valid values: true, false. true means to use default path mapping, false means to use custom path mapping.
    IsStatusOn bool
    Domain name resolution status. Valid values: true, false. true means normal parsing, false means parsing failed.
    NetType string
    Network type.
    PathMappings []GetApiGatewayCustomerDomainsListPathMapping
    Domain name mapping path and environment list.
    Protocol string
    Custom domain name agreement type.
    certificateId String
    The certificate ID.
    domainName String
    Domain name.
    isDefaultMapping Boolean
    Whether to use default path mapping. Valid values: true, false. true means to use default path mapping, false means to use custom path mapping.
    isStatusOn Boolean
    Domain name resolution status. Valid values: true, false. true means normal parsing, false means parsing failed.
    netType String
    Network type.
    pathMappings List<GetApiGatewayCustomerDomainsListPathMapping>
    Domain name mapping path and environment list.
    protocol String
    Custom domain name agreement type.
    certificateId string
    The certificate ID.
    domainName string
    Domain name.
    isDefaultMapping boolean
    Whether to use default path mapping. Valid values: true, false. true means to use default path mapping, false means to use custom path mapping.
    isStatusOn boolean
    Domain name resolution status. Valid values: true, false. true means normal parsing, false means parsing failed.
    netType string
    Network type.
    pathMappings GetApiGatewayCustomerDomainsListPathMapping[]
    Domain name mapping path and environment list.
    protocol string
    Custom domain name agreement type.
    certificate_id str
    The certificate ID.
    domain_name str
    Domain name.
    is_default_mapping bool
    Whether to use default path mapping. Valid values: true, false. true means to use default path mapping, false means to use custom path mapping.
    is_status_on bool
    Domain name resolution status. Valid values: true, false. true means normal parsing, false means parsing failed.
    net_type str
    Network type.
    path_mappings Sequence[GetApiGatewayCustomerDomainsListPathMapping]
    Domain name mapping path and environment list.
    protocol str
    Custom domain name agreement type.
    certificateId String
    The certificate ID.
    domainName String
    Domain name.
    isDefaultMapping Boolean
    Whether to use default path mapping. Valid values: true, false. true means to use default path mapping, false means to use custom path mapping.
    isStatusOn Boolean
    Domain name resolution status. Valid values: true, false. true means normal parsing, false means parsing failed.
    netType String
    Network type.
    pathMappings List<Property Map>
    Domain name mapping path and environment list.
    protocol String
    Custom domain name agreement type.

    GetApiGatewayCustomerDomainsListPathMapping

    Environment string
    Release environment.
    Path string
    The domain mapping path.
    Environment string
    Release environment.
    Path string
    The domain mapping path.
    environment String
    Release environment.
    path String
    The domain mapping path.
    environment string
    Release environment.
    path string
    The domain mapping path.
    environment str
    Release environment.
    path str
    The domain mapping path.
    environment String
    Release environment.
    path String
    The domain mapping path.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate