GetApis

This data source provides the apis of the current Alibaba Cloud user.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var dataApigatwayApis = Output.Create(AliCloud.ApiGateway.GetApis.InvokeAsync(new AliCloud.ApiGateway.GetApisArgs
        {
            OutputFile = "output_ApiGatawayApis",
        }));
        this.FirstApiId = data.Alicloud_api_gateway_apis.Data_apigatway.Apis[0].Id;
    }

    [Output("firstApiId")]
    public Output<string> FirstApiId { get; set; }
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

data_apigatway_apis = alicloud.apigateway.get_apis(output_file="output_ApiGatawayApis")
pulumi.export("firstApiId", data["alicloud.apigateway.getApis"]["data_apigatway"]["apis"][0]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const dataApigatwayApis = pulumi.output(alicloud.apigateway.getApis({
    outputFile: "output_ApiGatawayApis",
}, { async: true }));

export const firstApiId = alicloud_api_gateway_apis_data_apigatway.apis.0.id;

Using GetApis

function getApis(args: GetApisArgs, opts?: InvokeOptions): Promise<GetApisResult>
function  get_apis(api_id=None, group_id=None, ids=None, name_regex=None, output_file=None, opts=None)
func GetApis(ctx *Context, args *GetApisArgs, opts ...InvokeOption) (*GetApisResult, error)
public static class GetApis {
    public static Task<GetApisResult> InvokeAsync(GetApisArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ApiId string

(It has been deprecated from version 1.52.2, and use field ‘ids’ to replace.) ID of the specified API.

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

GroupId string

ID of the specified group.

Ids List<string>

A list of api IDs.

NameRegex string

A regex string to filter api gateway apis by name.

OutputFile string
ApiId string

(It has been deprecated from version 1.52.2, and use field ‘ids’ to replace.) ID of the specified API.

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

GroupId string

ID of the specified group.

Ids []string

A list of api IDs.

NameRegex string

A regex string to filter api gateway apis by name.

OutputFile string
apiId string

(It has been deprecated from version 1.52.2, and use field ‘ids’ to replace.) ID of the specified API.

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

groupId string

ID of the specified group.

ids string[]

A list of api IDs.

nameRegex string

A regex string to filter api gateway apis by name.

outputFile string
api_id str

(It has been deprecated from version 1.52.2, and use field ‘ids’ to replace.) ID of the specified API.

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

group_id str

ID of the specified group.

ids List[str]

A list of api IDs.

name_regex str

A regex string to filter api gateway apis by name.

output_file str

GetApis Result

The following output properties are available:

Apis List<Pulumi.AliCloud.ApiGateway.Outputs.GetApisApi>

A list of apis. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

A list of api IDs.

Names List<string>

A list of api names.

ApiId string

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

GroupId string

The group id that the apis belong to.

NameRegex string
OutputFile string
Apis []GetApisApi

A list of apis. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids []string

A list of api IDs.

Names []string

A list of api names.

ApiId string

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

GroupId string

The group id that the apis belong to.

NameRegex string
OutputFile string
apis GetApisApi[]

A list of apis. Each element contains the following attributes:

id string

The provider-assigned unique ID for this managed resource.

ids string[]

A list of api IDs.

names string[]

A list of api names.

apiId string

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

groupId string

The group id that the apis belong to.

nameRegex string
outputFile string
apis List[GetApisApi]

A list of apis. Each element contains the following attributes:

id str

The provider-assigned unique ID for this managed resource.

ids List[str]

A list of api IDs.

names List[str]

A list of api names.

api_id str

Deprecated: Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

group_id str

The group id that the apis belong to.

name_regex str
output_file str

Supporting Types

GetApisApi

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Description string

API description.

GroupId string

ID of the specified group.

GroupName string

The group name that the apis belong to.

Id string

API ID, which is generated by the system and globally unique.

Name string

API name.

RegionId string

The ID of the region where the API is located.

Description string

API description.

GroupId string

ID of the specified group.

GroupName string

The group name that the apis belong to.

Id string

API ID, which is generated by the system and globally unique.

Name string

API name.

RegionId string

The ID of the region where the API is located.

description string

API description.

groupId string

ID of the specified group.

groupName string

The group name that the apis belong to.

id string

API ID, which is generated by the system and globally unique.

name string

API name.

regionId string

The ID of the region where the API is located.

description str

API description.

group_id str

ID of the specified group.

group_name str

The group name that the apis belong to.

id str

API ID, which is generated by the system and globally unique.

name str

API name.

regionId str

The ID of the region where the API is located.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.