Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. getApigwGroupsV2
opentelekomcloud 1.36.47 published on Thursday, Sep 4, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.getApigwGroupsV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.47 published on Thursday, Sep 4, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

    Up-to-date reference of API arguments for API Gateway groups service you can get at documentation portal

    Use this data source to query the group list under the APIGW instance within OpenTelekomCloud.

    Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const groupName = config.requireObject("groupName");
const test = opentelekomcloud.getApigwGroupsV2({
    instanceId: instanceId,
    name: groupName,
});

    import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
instance_id = config.require_object("instanceId")
group_name = config.require_object("groupName")
test = opentelekomcloud.get_apigw_groups_v2(instance_id=instance_id,
    name=group_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		groupName := cfg.RequireObject("groupName")
		_, err := opentelekomcloud.GetApigwGroupsV2(ctx, &opentelekomcloud.GetApigwGroupsV2Args{
			InstanceId: instanceId,
			Name:       pulumi.StringRef(groupName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var groupName = config.RequireObject<dynamic>("groupName");
    var test = Opentelekomcloud.GetApigwGroupsV2.Invoke(new()
    {
        InstanceId = instanceId,
        Name = groupName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
import com.pulumi.opentelekomcloud.inputs.GetApigwGroupsV2Args;
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 config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var groupName = config.get("groupName");
        final var test = OpentelekomcloudFunctions.getApigwGroupsV2(GetApigwGroupsV2Args.builder()
            .instanceId(instanceId)
            .name(groupName)
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  groupName:
    type: dynamic
variables:
  test:
    fn::invoke:
      function: opentelekomcloud:getApigwGroupsV2
      arguments:
        instanceId: ${instanceId}
        name: ${groupName}

    Using getApigwGroupsV2

    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 getApigwGroupsV2(args: GetApigwGroupsV2Args, opts?: InvokeOptions): Promise<GetApigwGroupsV2Result>
function getApigwGroupsV2Output(args: GetApigwGroupsV2OutputArgs, opts?: InvokeOptions): Output<GetApigwGroupsV2Result>
    def get_apigw_groups_v2(group_id: Optional[str] = None,
                        id: Optional[str] = None,
                        instance_id: Optional[str] = None,
                        name: Optional[str] = None,
                        region: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetApigwGroupsV2Result
def get_apigw_groups_v2_output(group_id: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        instance_id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        region: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetApigwGroupsV2Result]
    func GetApigwGroupsV2(ctx *Context, args *GetApigwGroupsV2Args, opts ...InvokeOption) (*GetApigwGroupsV2Result, error)
func GetApigwGroupsV2Output(ctx *Context, args *GetApigwGroupsV2OutputArgs, opts ...InvokeOption) GetApigwGroupsV2ResultOutput

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

    public static class GetApigwGroupsV2 
{
    public static Task<GetApigwGroupsV2Result> InvokeAsync(GetApigwGroupsV2Args args, InvokeOptions? opts = null)
    public static Output<GetApigwGroupsV2Result> Invoke(GetApigwGroupsV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApigwGroupsV2Result> getApigwGroupsV2(GetApigwGroupsV2Args args, InvokeOptions options)
public static Output<GetApigwGroupsV2Result> getApigwGroupsV2(GetApigwGroupsV2Args args, InvokeOptions options)

    fn::invoke:
  function: opentelekomcloud:index/getApigwGroupsV2:getApigwGroupsV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Specifies an ID of the APIGW dedicated instance to which the API group belongs.
    GroupId string
    Specifies the API group ID used to query.
    Id string
    The variable ID.
    Name string
    Specifies the API group name used to query.
    Region string
    The region in which to query the data source.
    InstanceId string
    Specifies an ID of the APIGW dedicated instance to which the API group belongs.
    GroupId string
    Specifies the API group ID used to query.
    Id string
    The variable ID.
    Name string
    Specifies the API group name used to query.
    Region string
    The region in which to query the data source.
    instanceId String
    Specifies an ID of the APIGW dedicated instance to which the API group belongs.
    groupId String
    Specifies the API group ID used to query.
    id String
    The variable ID.
    name String
    Specifies the API group name used to query.
    region String
    The region in which to query the data source.
    instanceId string
    Specifies an ID of the APIGW dedicated instance to which the API group belongs.
    groupId string
    Specifies the API group ID used to query.
    id string
    The variable ID.
    name string
    Specifies the API group name used to query.
    region string
    The region in which to query the data source.
    instance_id str
    Specifies an ID of the APIGW dedicated instance to which the API group belongs.
    group_id str
    Specifies the API group ID used to query.
    id str
    The variable ID.
    name str
    Specifies the API group name used to query.
    region str
    The region in which to query the data source.
    instanceId String
    Specifies an ID of the APIGW dedicated instance to which the API group belongs.
    groupId String
    Specifies the API group ID used to query.
    id String
    The variable ID.
    name String
    Specifies the API group name used to query.
    region String
    The region in which to query the data source.

    getApigwGroupsV2 Result

    The following output properties are available:

    Groups List<GetApigwGroupsV2Group>
    All groups that match the filter parameters. The groups structure is documented below.
    Id string
    The variable ID.
    InstanceId string
    Region string
    The region in which to query the data source.
    GroupId string
    Name string
    The variable name.
    Groups []GetApigwGroupsV2Group
    All groups that match the filter parameters. The groups structure is documented below.
    Id string
    The variable ID.
    InstanceId string
    Region string
    The region in which to query the data source.
    GroupId string
    Name string
    The variable name.
    groups List<GetApigwGroupsV2Group>
    All groups that match the filter parameters. The groups structure is documented below.
    id String
    The variable ID.
    instanceId String
    region String
    The region in which to query the data source.
    groupId String
    name String
    The variable name.
    groups GetApigwGroupsV2Group[]
    All groups that match the filter parameters. The groups structure is documented below.
    id string
    The variable ID.
    instanceId string
    region string
    The region in which to query the data source.
    groupId string
    name string
    The variable name.
    groups Sequence[GetApigwGroupsV2Group]
    All groups that match the filter parameters. The groups structure is documented below.
    id str
    The variable ID.
    instance_id str
    region str
    The region in which to query the data source.
    group_id str
    name str
    The variable name.
    groups List<Property Map>
    All groups that match the filter parameters. The groups structure is documented below.
    id String
    The variable ID.
    instanceId String
    region String
    The region in which to query the data source.
    groupId String
    name String
    The variable name.

    Supporting Types

    GetApigwGroupsV2Group

    CreatedAt string
    The creation time of the API group.
    Description string
    The description of the API group.
    Environments List<GetApigwGroupsV2GroupEnvironment>
    The array of one or more environments of the API group. The environment structure is documented below.
    Id string
    The variable ID.
    IsDefault double
    Indicates whether the API group is the default group.
    Name string
    Specifies the API group name used to query.
    OnSellStatus double
    Whether it has been listed on the cloud store. The valid values are as follows:

    • 1: Listed.
    • 2: Not listed.
    • 3: Under review.
    SlDomain string
    The subdomain name assigned by the system by default.
    SlDomains List<string>
    List of subdomain names assigned by the system by default.
    Status double
    The current status of the API group. The valid values are as follows:

    • 1: Normal.
    UpdatedAt string
    The latest update time of the API group.
    UrlDomains List<GetApigwGroupsV2GroupUrlDomain>
    List of independent domains bound on the API group. The url_domains structure is documented below.
    CreatedAt string
    The creation time of the API group.
    Description string
    The description of the API group.
    Environments []GetApigwGroupsV2GroupEnvironment
    The array of one or more environments of the API group. The environment structure is documented below.
    Id string
    The variable ID.
    IsDefault float64
    Indicates whether the API group is the default group.
    Name string
    Specifies the API group name used to query.
    OnSellStatus float64
    Whether it has been listed on the cloud store. The valid values are as follows:

    • 1: Listed.
    • 2: Not listed.
    • 3: Under review.
    SlDomain string
    The subdomain name assigned by the system by default.
    SlDomains []string
    List of subdomain names assigned by the system by default.
    Status float64
    The current status of the API group. The valid values are as follows:

    • 1: Normal.
    UpdatedAt string
    The latest update time of the API group.
    UrlDomains []GetApigwGroupsV2GroupUrlDomain
    List of independent domains bound on the API group. The url_domains structure is documented below.
    createdAt String
    The creation time of the API group.
    description String
    The description of the API group.
    environments List<GetApigwGroupsV2GroupEnvironment>
    The array of one or more environments of the API group. The environment structure is documented below.
    id String
    The variable ID.
    isDefault Double
    Indicates whether the API group is the default group.
    name String
    Specifies the API group name used to query.
    onSellStatus Double
    Whether it has been listed on the cloud store. The valid values are as follows:

    • 1: Listed.
    • 2: Not listed.
    • 3: Under review.
    slDomain String
    The subdomain name assigned by the system by default.
    slDomains List<String>
    List of subdomain names assigned by the system by default.
    status Double
    The current status of the API group. The valid values are as follows:

    • 1: Normal.
    updatedAt String
    The latest update time of the API group.
    urlDomains List<GetApigwGroupsV2GroupUrlDomain>
    List of independent domains bound on the API group. The url_domains structure is documented below.
    createdAt string
    The creation time of the API group.
    description string
    The description of the API group.
    environments GetApigwGroupsV2GroupEnvironment[]
    The array of one or more environments of the API group. The environment structure is documented below.
    id string
    The variable ID.
    isDefault number
    Indicates whether the API group is the default group.
    name string
    Specifies the API group name used to query.
    onSellStatus number
    Whether it has been listed on the cloud store. The valid values are as follows:

    • 1: Listed.
    • 2: Not listed.
    • 3: Under review.
    slDomain string
    The subdomain name assigned by the system by default.
    slDomains string[]
    List of subdomain names assigned by the system by default.
    status number
    The current status of the API group. The valid values are as follows:

    • 1: Normal.
    updatedAt string
    The latest update time of the API group.
    urlDomains GetApigwGroupsV2GroupUrlDomain[]
    List of independent domains bound on the API group. The url_domains structure is documented below.
    created_at str
    The creation time of the API group.
    description str
    The description of the API group.
    environments Sequence[GetApigwGroupsV2GroupEnvironment]
    The array of one or more environments of the API group. The environment structure is documented below.
    id str
    The variable ID.
    is_default float
    Indicates whether the API group is the default group.
    name str
    Specifies the API group name used to query.
    on_sell_status float
    Whether it has been listed on the cloud store. The valid values are as follows:

    • 1: Listed.
    • 2: Not listed.
    • 3: Under review.
    sl_domain str
    The subdomain name assigned by the system by default.
    sl_domains Sequence[str]
    List of subdomain names assigned by the system by default.
    status float
    The current status of the API group. The valid values are as follows:

    • 1: Normal.
    updated_at str
    The latest update time of the API group.
    url_domains Sequence[GetApigwGroupsV2GroupUrlDomain]
    List of independent domains bound on the API group. The url_domains structure is documented below.
    createdAt String
    The creation time of the API group.
    description String
    The description of the API group.
    environments List<Property Map>
    The array of one or more environments of the API group. The environment structure is documented below.
    id String
    The variable ID.
    isDefault Number
    Indicates whether the API group is the default group.
    name String
    Specifies the API group name used to query.
    onSellStatus Number
    Whether it has been listed on the cloud store. The valid values are as follows:

    • 1: Listed.
    • 2: Not listed.
    • 3: Under review.
    slDomain String
    The subdomain name assigned by the system by default.
    slDomains List<String>
    List of subdomain names assigned by the system by default.
    status Number
    The current status of the API group. The valid values are as follows:

    • 1: Normal.
    updatedAt String
    The latest update time of the API group.
    urlDomains List<Property Map>
    List of independent domains bound on the API group. The url_domains structure is documented below.

    GetApigwGroupsV2GroupEnvironment

    EnvironmentId string
    The ID of the environment to which the variables belong.
    Variables List<GetApigwGroupsV2GroupEnvironmentVariable>
    The array of one or more environment variables. The variable structure is documented below.
    EnvironmentId string
    The ID of the environment to which the variables belong.
    Variables []GetApigwGroupsV2GroupEnvironmentVariable
    The array of one or more environment variables. The variable structure is documented below.
    environmentId String
    The ID of the environment to which the variables belong.
    variables List<GetApigwGroupsV2GroupEnvironmentVariable>
    The array of one or more environment variables. The variable structure is documented below.
    environmentId string
    The ID of the environment to which the variables belong.
    variables GetApigwGroupsV2GroupEnvironmentVariable[]
    The array of one or more environment variables. The variable structure is documented below.
    environment_id str
    The ID of the environment to which the variables belong.
    variables Sequence[GetApigwGroupsV2GroupEnvironmentVariable]
    The array of one or more environment variables. The variable structure is documented below.
    environmentId String
    The ID of the environment to which the variables belong.
    variables List<Property Map>
    The array of one or more environment variables. The variable structure is documented below.

    GetApigwGroupsV2GroupEnvironmentVariable

    Id string
    The variable ID.
    Name string
    Specifies the API group name used to query.
    Value string
    The variable value.
    Id string
    The variable ID.
    Name string
    Specifies the API group name used to query.
    Value string
    The variable value.
    id String
    The variable ID.
    name String
    Specifies the API group name used to query.
    value String
    The variable value.
    id string
    The variable ID.
    name string
    Specifies the API group name used to query.
    value string
    The variable value.
    id str
    The variable ID.
    name str
    Specifies the API group name used to query.
    value str
    The variable value.
    id String
    The variable ID.
    name String
    Specifies the API group name used to query.
    value String
    The variable value.

    GetApigwGroupsV2GroupUrlDomain

    CnameStatus double
    CNAME resolution status of the domain name. The valid values are as follows:

    • 1: Not resolved.
    • 2: Resolving.
    • 3: Resolved.
    • 4: Resolution failed.
    Id string
    The variable ID.
    IsHasTrustedRootCa bool
    Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
    MinSslVersion string
    Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

    • TLSv1.1
    • TLSv1.2
    Name string
    Specifies the API group name used to query.
    SslId string
    The SSL certificate ID.
    SslName string
    The SSL certificate name.
    VerifiedClientCertificateEnabled bool
    Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
    CnameStatus float64
    CNAME resolution status of the domain name. The valid values are as follows:

    • 1: Not resolved.
    • 2: Resolving.
    • 3: Resolved.
    • 4: Resolution failed.
    Id string
    The variable ID.
    IsHasTrustedRootCa bool
    Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
    MinSslVersion string
    Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

    • TLSv1.1
    • TLSv1.2
    Name string
    Specifies the API group name used to query.
    SslId string
    The SSL certificate ID.
    SslName string
    The SSL certificate name.
    VerifiedClientCertificateEnabled bool
    Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
    cnameStatus Double
    CNAME resolution status of the domain name. The valid values are as follows:

    • 1: Not resolved.
    • 2: Resolving.
    • 3: Resolved.
    • 4: Resolution failed.
    id String
    The variable ID.
    isHasTrustedRootCa Boolean
    Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
    minSslVersion String
    Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

    • TLSv1.1
    • TLSv1.2
    name String
    Specifies the API group name used to query.
    sslId String
    The SSL certificate ID.
    sslName String
    The SSL certificate name.
    verifiedClientCertificateEnabled Boolean
    Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
    cnameStatus number
    CNAME resolution status of the domain name. The valid values are as follows:

    • 1: Not resolved.
    • 2: Resolving.
    • 3: Resolved.
    • 4: Resolution failed.
    id string
    The variable ID.
    isHasTrustedRootCa boolean
    Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
    minSslVersion string
    Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

    • TLSv1.1
    • TLSv1.2
    name string
    Specifies the API group name used to query.
    sslId string
    The SSL certificate ID.
    sslName string
    The SSL certificate name.
    verifiedClientCertificateEnabled boolean
    Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
    cname_status float
    CNAME resolution status of the domain name. The valid values are as follows:

    • 1: Not resolved.
    • 2: Resolving.
    • 3: Resolved.
    • 4: Resolution failed.
    id str
    The variable ID.
    is_has_trusted_root_ca bool
    Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
    min_ssl_version str
    Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

    • TLSv1.1
    • TLSv1.2
    name str
    Specifies the API group name used to query.
    ssl_id str
    The SSL certificate ID.
    ssl_name str
    The SSL certificate name.
    verified_client_certificate_enabled bool
    Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
    cnameStatus Number
    CNAME resolution status of the domain name. The valid values are as follows:

    • 1: Not resolved.
    • 2: Resolving.
    • 3: Resolved.
    • 4: Resolution failed.
    id String
    The variable ID.
    isHasTrustedRootCa Boolean
    Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
    minSslVersion String
    Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

    • TLSv1.1
    • TLSv1.2
    name String
    Specifies the API group name used to query.
    sslId String
    The SSL certificate ID.
    sslName String
    The SSL certificate name.
    verifiedClientCertificateEnabled Boolean
    Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.47 published on Thursday, Sep 4, 2025 by opentelekomcloud
    opentelekomcloud/terraform-provider-opentelekomcloud