pulumi-alicloud-kotlin/com.pulumi.alicloud.apigateway.kotlin/ApigatewayFunctions/getApis

getApis

suspend fun getApis(argument: GetApisPlainArgs): GetApisResult

This data source provides the Api Gateway APIs of the current Alibaba Cloud user.

NOTE: Available since v1.22.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new alicloud.apigateway.Group("default", {
    name: name,
    description: name,
});
const defaultApi = new alicloud.apigateway.Api("default", {
    groupId: _default.id,
    name: name,
    description: name,
    authType: "APP",
    serviceType: "HTTP",
    requestConfig: {
        protocol: "HTTP",
        method: "GET",
        path: "/test/path",
        mode: "MAPPING",
    },
    httpServiceConfig: {
        address: "http://apigateway-backend.alicloudapi.com:8080",
        method: "GET",
        path: "/web/cloudapi",
        timeout: 20,
        aoneName: "cloudapi-openapi",
    },
    requestParameters: [{
        name: name,
        type: "STRING",
        required: "OPTIONAL",
        "in": "QUERY",
        inService: "QUERY",
        nameService: name,
    }],
});
const ids = alicloud.apigateway.getApisOutput({
    ids: [defaultApi.id],
});
export const apiGatewayApisId0 = ids.apply(ids => ids.apis?.[0]?.id);
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.apigateway.Group("default",
    name=name,
    description=name)
default_api = alicloud.apigateway.Api("default",
    group_id=default.id,
    name=name,
    description=name,
    auth_type="APP",
    service_type="HTTP",
    request_config={
        "protocol": "HTTP",
        "method": "GET",
        "path": "/test/path",
        "mode": "MAPPING",
    },
    http_service_config={
        "address": "http://apigateway-backend.alicloudapi.com:8080",
        "method": "GET",
        "path": "/web/cloudapi",
        "timeout": 20,
        "aone_name": "cloudapi-openapi",
    },
    request_parameters=[{
        "name": name,
        "type": "STRING",
        "required": "OPTIONAL",
        "in_": "QUERY",
        "in_service": "QUERY",
        "name_service": name,
    }])
ids = alicloud.apigateway.get_apis_output(ids=[default_api.id])
pulumi.export("apiGatewayApisId0", ids.apis[0].id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = new AliCloud.ApiGateway.Group("default", new()
    {
        Name = name,
        Description = name,
    });
    var defaultApi = new AliCloud.ApiGateway.Api("default", new()
    {
        GroupId = @default.Id,
        Name = name,
        Description = name,
        AuthType = "APP",
        ServiceType = "HTTP",
        RequestConfig = new AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs
        {
            Protocol = "HTTP",
            Method = "GET",
            Path = "/test/path",
            Mode = "MAPPING",
        },
        HttpServiceConfig = new AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs
        {
            Address = "http://apigateway-backend.alicloudapi.com:8080",
            Method = "GET",
            Path = "/web/cloudapi",
            Timeout = 20,
            AoneName = "cloudapi-openapi",
        },
        RequestParameters = new[]
        {
            new AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs
            {
                Name = name,
                Type = "STRING",
                Required = "OPTIONAL",
                In = "QUERY",
                InService = "QUERY",
                NameService = name,
            },
        },
    });
    var ids = AliCloud.ApiGateway.GetApis.Invoke(new()
    {
        Ids = new[]
        {
            defaultApi.Id,
        },
    });
    return new Dictionary<string, object?>
    {
        ["apiGatewayApisId0"] = ids&#46;Apply(getApisResult => getApisResult&#46;Apis[0]?.Id),
    };
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"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, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := apigateway.NewGroup(ctx, "default", &apigateway.GroupArgs{
			Name:        pulumi.String(name),
			Description: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultApi, err := apigateway.NewApi(ctx, "default", &apigateway.ApiArgs{
			GroupId:     _default.ID(),
			Name:        pulumi.String(name),
			Description: pulumi.String(name),
			AuthType:    pulumi.String("APP"),
			ServiceType: pulumi.String("HTTP"),
			RequestConfig: &apigateway.ApiRequestConfigArgs{
				Protocol: pulumi.String("HTTP"),
				Method:   pulumi.String("GET"),
				Path:     pulumi.String("/test/path"),
				Mode:     pulumi.String("MAPPING"),
			},
			HttpServiceConfig: &apigateway.ApiHttpServiceConfigArgs{
				Address:  pulumi.String("http://apigateway-backend.alicloudapi.com:8080"),
				Method:   pulumi.String("GET"),
				Path:     pulumi.String("/web/cloudapi"),
				Timeout:  pulumi.Int(20),
				AoneName: pulumi.String("cloudapi-openapi"),
			},
			RequestParameters: apigateway.ApiRequestParameterArray{
				&apigateway.ApiRequestParameterArgs{
					Name:        pulumi.String(name),
					Type:        pulumi.String("STRING"),
					Required:    pulumi.String("OPTIONAL"),
					In:          pulumi.String("QUERY"),
					InService:   pulumi.String("QUERY"),
					NameService: pulumi.String(name),
				},
			},
		})
		if err != nil {
			return err
		}
		ids := apigateway.GetApisOutput(ctx, apigateway.GetApisOutputArgs{
			Ids: pulumi.StringArray{
				defaultApi.ID(),
			},
		}, nil)
		ctx.Export("apiGatewayApisId0", ids.ApplyT(func(ids apigateway.GetApisResult) (*string, error) {
			return &ids.Apis[0].Id, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Group;
import com.pulumi.alicloud.apigateway.GroupArgs;
import com.pulumi.alicloud.apigateway.Api;
import com.pulumi.alicloud.apigateway.ApiArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiHttpServiceConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestParameterArgs;
import com.pulumi.alicloud.apigateway.ApigatewayFunctions;
import com.pulumi.alicloud.apigateway.inputs.GetApisArgs;
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 name = config.get("name").orElse("terraform-example");
        var default_ = new Group("default", GroupArgs.builder()
            .name(name)
            .description(name)
            .build());
        var defaultApi = new Api("defaultApi", ApiArgs.builder()
            .groupId(default_.id())
            .name(name)
            .description(name)
            .authType("APP")
            .serviceType("HTTP")
            .requestConfig(ApiRequestConfigArgs.builder()
                .protocol("HTTP")
                .method("GET")
                .path("/test/path")
                .mode("MAPPING")
                .build())
            .httpServiceConfig(ApiHttpServiceConfigArgs.builder()
                .address("http://apigateway-backend.alicloudapi.com:8080")
                .method("GET")
                .path("/web/cloudapi")
                .timeout(20)
                .aoneName("cloudapi-openapi")
                .build())
            .requestParameters(ApiRequestParameterArgs.builder()
                .name(name)
                .type("STRING")
                .required("OPTIONAL")
                .in("QUERY")
                .inService("QUERY")
                .nameService(name)
                .build())
            .build());
        final var ids = ApigatewayFunctions.getApis(GetApisArgs.builder()
            .ids(defaultApi.id())
            .build());
        ctx.export("apiGatewayApisId0", ids.applyValue(_ids -> _ids.apis()[0].id()));
    }
}
Content copied to clipboard
configuration:
  name:
    type: string
    default: terraform-example
resources:
  default:
    type: alicloud:apigateway:Group
    properties:
      name: ${name}
      description: ${name}
  defaultApi:
    type: alicloud:apigateway:Api
    name: default
    properties:
      groupId: ${default.id}
      name: ${name}
      description: ${name}
      authType: APP
      serviceType: HTTP
      requestConfig:
        protocol: HTTP
        method: GET
        path: /test/path
        mode: MAPPING
      httpServiceConfig:
        address: http://apigateway-backend.alicloudapi.com:8080
        method: GET
        path: /web/cloudapi
        timeout: 20
        aoneName: cloudapi-openapi
      requestParameters:
        - name: ${name}
          type: STRING
          required: OPTIONAL
          in: QUERY
          inService: QUERY
          nameService: ${name}
variables:
  ids:
    fn::invoke:
      function: alicloud:apigateway:getApis
      arguments:
        ids:
          - ${defaultApi.id}
outputs:
  apiGatewayApisId0: ${ids.apis[0].id}
Content copied to clipboard

Return

A collection of values returned by getApis.

Parameters

argument

A collection of arguments for invoking getApis.

suspend fun getApis(apiId: String? = null, groupId: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null): GetApisResult

Return

A collection of values returned by getApis.

Parameters

apiId

The ID of the API.

groupId

The ID of the API group.

ids

A list of API IDs.

nameRegex

A regex string to filter results by API name.

outputFile

File name where to save data source results (after running pulumi preview).

See also

.

suspend fun getApis(argument: suspend GetApisPlainArgsBuilder.() -> Unit): GetApisResult

Return

A collection of values returned by getApis.

Parameters

argument

Builder for com.pulumi.alicloud.apigateway.kotlin.inputs.GetApisPlainArgs.

See also

.