Volcengine v0.0.31, May 12 25

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine.veecp.getBatchEdgeMachines

Explore with Pulumi AI

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

Example Usage

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

const fooBatchEdgeMachine = new volcengine.veecp.BatchEdgeMachine("fooBatchEdgeMachine", {
    clusterId: "ccvd7mte6t101fno98u60",
    nodePoolId: "pcvd90uacnsr73g6bjic0",
    ttlHours: 1,
});
const fooBatchEdgeMachines = volcengine.veecp.getBatchEdgeMachinesOutput({
    clusterIds: [fooBatchEdgeMachine.clusterId],
    ids: [fooBatchEdgeMachine.id],
});

import pulumi
import pulumi_volcengine as volcengine

foo_batch_edge_machine = volcengine.veecp.BatchEdgeMachine("fooBatchEdgeMachine",
    cluster_id="ccvd7mte6t101fno98u60",
    node_pool_id="pcvd90uacnsr73g6bjic0",
    ttl_hours=1)
foo_batch_edge_machines = volcengine.veecp.get_batch_edge_machines_output(cluster_ids=[foo_batch_edge_machine.cluster_id],
    ids=[foo_batch_edge_machine.id])

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/veecp"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooBatchEdgeMachine, err := veecp.NewBatchEdgeMachine(ctx, "fooBatchEdgeMachine", &veecp.BatchEdgeMachineArgs{
			ClusterId:  pulumi.String("ccvd7mte6t101fno98u60"),
			NodePoolId: pulumi.String("pcvd90uacnsr73g6bjic0"),
			TtlHours:   pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_ = veecp.GetBatchEdgeMachinesOutput(ctx, veecp.GetBatchEdgeMachinesOutputArgs{
			ClusterIds: pulumi.StringArray{
				fooBatchEdgeMachine.ClusterId,
			},
			Ids: pulumi.StringArray{
				fooBatchEdgeMachine.ID(),
			},
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooBatchEdgeMachine = new Volcengine.Veecp.BatchEdgeMachine("fooBatchEdgeMachine", new()
    {
        ClusterId = "ccvd7mte6t101fno98u60",
        NodePoolId = "pcvd90uacnsr73g6bjic0",
        TtlHours = 1,
    });

    var fooBatchEdgeMachines = Volcengine.Veecp.GetBatchEdgeMachines.Invoke(new()
    {
        ClusterIds = new[]
        {
            fooBatchEdgeMachine.ClusterId,
        },
        Ids = new[]
        {
            fooBatchEdgeMachine.Id,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.veecp.BatchEdgeMachine;
import com.pulumi.volcengine.veecp.BatchEdgeMachineArgs;
import com.pulumi.volcengine.veecp.VeecpFunctions;
import com.pulumi.volcengine.veecp.inputs.GetBatchEdgeMachinesArgs;
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 fooBatchEdgeMachine = new BatchEdgeMachine("fooBatchEdgeMachine", BatchEdgeMachineArgs.builder()        
            .clusterId("ccvd7mte6t101fno98u60")
            .nodePoolId("pcvd90uacnsr73g6bjic0")
            .ttlHours(1)
            .build());

        final var fooBatchEdgeMachines = VeecpFunctions.getBatchEdgeMachines(GetBatchEdgeMachinesArgs.builder()
            .clusterIds(fooBatchEdgeMachine.clusterId())
            .ids(fooBatchEdgeMachine.id())
            .build());

    }
}

resources:
  fooBatchEdgeMachine:
    type: volcengine:veecp:BatchEdgeMachine
    properties:
      clusterId: ccvd7mte6t101fno98u60
      nodePoolId: pcvd90uacnsr73g6bjic0
      ttlHours: 1
variables:
  fooBatchEdgeMachines:
    fn::invoke:
      Function: volcengine:veecp:getBatchEdgeMachines
      Arguments:
        clusterIds:
          - ${fooBatchEdgeMachine.clusterId}
        ids:
          - ${fooBatchEdgeMachine.id}

Using getBatchEdgeMachines

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 getBatchEdgeMachines(args: GetBatchEdgeMachinesArgs, opts?: InvokeOptions): Promise<GetBatchEdgeMachinesResult>
function getBatchEdgeMachinesOutput(args: GetBatchEdgeMachinesOutputArgs, opts?: InvokeOptions): Output<GetBatchEdgeMachinesResult>

def get_batch_edge_machines(cluster_ids: Optional[Sequence[str]] = None,
                            create_client_token: Optional[str] = None,
                            ids: Optional[Sequence[str]] = None,
                            ips: Optional[Sequence[str]] = None,
                            name: Optional[str] = None,
                            need_bootstrap_script: Optional[str] = None,
                            output_file: Optional[str] = None,
                            statuses: Optional[Sequence[GetBatchEdgeMachinesStatus]] = None,
                            zone_ids: Optional[Sequence[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetBatchEdgeMachinesResult
def get_batch_edge_machines_output(cluster_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            create_client_token: Optional[pulumi.Input[str]] = None,
                            ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            need_bootstrap_script: Optional[pulumi.Input[str]] = None,
                            output_file: Optional[pulumi.Input[str]] = None,
                            statuses: Optional[pulumi.Input[Sequence[pulumi.Input[GetBatchEdgeMachinesStatusArgs]]]] = None,
                            zone_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetBatchEdgeMachinesResult]

func GetBatchEdgeMachines(ctx *Context, args *GetBatchEdgeMachinesArgs, opts ...InvokeOption) (*GetBatchEdgeMachinesResult, error)
func GetBatchEdgeMachinesOutput(ctx *Context, args *GetBatchEdgeMachinesOutputArgs, opts ...InvokeOption) GetBatchEdgeMachinesResultOutput

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

public static class GetBatchEdgeMachines 
{
    public static Task<GetBatchEdgeMachinesResult> InvokeAsync(GetBatchEdgeMachinesArgs args, InvokeOptions? opts = null)
    public static Output<GetBatchEdgeMachinesResult> Invoke(GetBatchEdgeMachinesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBatchEdgeMachinesResult> getBatchEdgeMachines(GetBatchEdgeMachinesArgs args, InvokeOptions options)
public static Output<GetBatchEdgeMachinesResult> getBatchEdgeMachines(GetBatchEdgeMachinesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:veecp/getBatchEdgeMachines:getBatchEdgeMachines
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterIds List<string>: The ClusterIds of NodePool IDs.
CreateClientToken string: The ClientToken when successfully created.
Ids List<string>: A list of IDs.
Ips List<string>: The IPs.
Name string: The Name of NodePool.
NeedBootstrapScript string: Whether it is necessary to query the node management script.
OutputFile string: File name where to save data source results.
Statuses List<GetBatchEdgeMachinesStatus>: The Status of NodePool.
ZoneIds List<string>: The Zone Ids.

ClusterIds []string: The ClusterIds of NodePool IDs.
CreateClientToken string: The ClientToken when successfully created.
Ids []string: A list of IDs.
Ips []string: The IPs.
Name string: The Name of NodePool.
NeedBootstrapScript string: Whether it is necessary to query the node management script.
OutputFile string: File name where to save data source results.
Statuses []GetBatchEdgeMachinesStatus: The Status of NodePool.
ZoneIds []string: The Zone Ids.

clusterIds List<String>: The ClusterIds of NodePool IDs.
createClientToken String: The ClientToken when successfully created.
ids List<String>: A list of IDs.
ips List<String>: The IPs.
name String: The Name of NodePool.
needBootstrapScript String: Whether it is necessary to query the node management script.
outputFile String: File name where to save data source results.
statuses List<GetBatchEdgeMachinesStatus>: The Status of NodePool.
zoneIds List<String>: The Zone Ids.

clusterIds string[]: The ClusterIds of NodePool IDs.
createClientToken string: The ClientToken when successfully created.
ids string[]: A list of IDs.
ips string[]: The IPs.
name string: The Name of NodePool.
needBootstrapScript string: Whether it is necessary to query the node management script.
outputFile string: File name where to save data source results.
statuses GetBatchEdgeMachinesStatus[]: The Status of NodePool.
zoneIds string[]: The Zone Ids.

cluster_ids Sequence[str]: The ClusterIds of NodePool IDs.
create_client_token str: The ClientToken when successfully created.
ids Sequence[str]: A list of IDs.
ips Sequence[str]: The IPs.
name str: The Name of NodePool.
need_bootstrap_script str: Whether it is necessary to query the node management script.
output_file str: File name where to save data source results.
statuses Sequence[GetBatchEdgeMachinesStatus]: The Status of NodePool.
zone_ids Sequence[str]: The Zone Ids.

clusterIds List<String>: The ClusterIds of NodePool IDs.
createClientToken String: The ClientToken when successfully created.
ids List<String>: A list of IDs.
ips List<String>: The IPs.
name String: The Name of NodePool.
needBootstrapScript String: Whether it is necessary to query the node management script.
outputFile String: File name where to save data source results.
statuses List<Property Map>: The Status of NodePool.
zoneIds List<String>: The Zone Ids.

getBatchEdgeMachines Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Machines List<GetBatchEdgeMachinesMachine>: The collection of query.
TotalCount int: The total count of query.
ClusterIds List<string>
CreateClientToken string: The ClientToken when successfully created.
Ids List<string>
Ips List<string>
Name string: The Name of NodePool.
NeedBootstrapScript string
OutputFile string
Statuses List<GetBatchEdgeMachinesStatus>
ZoneIds List<string>

Id string: The provider-assigned unique ID for this managed resource.
Machines []GetBatchEdgeMachinesMachine: The collection of query.
TotalCount int: The total count of query.
ClusterIds []string
CreateClientToken string: The ClientToken when successfully created.
Ids []string
Ips []string
Name string: The Name of NodePool.
NeedBootstrapScript string
OutputFile string
Statuses []GetBatchEdgeMachinesStatus
ZoneIds []string

id String: The provider-assigned unique ID for this managed resource.
machines List<GetBatchEdgeMachinesMachine>: The collection of query.
totalCount Integer: The total count of query.
clusterIds List<String>
createClientToken String: The ClientToken when successfully created.
ids List<String>
ips List<String>
name String: The Name of NodePool.
needBootstrapScript String
outputFile String
statuses List<GetBatchEdgeMachinesStatus>
zoneIds List<String>

id string: The provider-assigned unique ID for this managed resource.
machines GetBatchEdgeMachinesMachine[]: The collection of query.
totalCount number: The total count of query.
clusterIds string[]
createClientToken string: The ClientToken when successfully created.
ids string[]
ips string[]
name string: The Name of NodePool.
needBootstrapScript string
outputFile string
statuses GetBatchEdgeMachinesStatus[]
zoneIds string[]

id str: The provider-assigned unique ID for this managed resource.
machines Sequence[GetBatchEdgeMachinesMachine]: The collection of query.
total_count int: The total count of query.
cluster_ids Sequence[str]
create_client_token str: The ClientToken when successfully created.
ids Sequence[str]
ips Sequence[str]
name str: The Name of NodePool.
need_bootstrap_script str
output_file str
statuses Sequence[GetBatchEdgeMachinesStatus]
zone_ids Sequence[str]

id String: The provider-assigned unique ID for this managed resource.
machines List<Property Map>: The collection of query.
totalCount Number: The total count of query.
clusterIds List<String>
createClientToken String: The ClientToken when successfully created.
ids List<String>
ips List<String>
name String: The Name of NodePool.
needBootstrapScript String
outputFile String
statuses List<Property Map>
zoneIds List<String>

Supporting Types

GetBatchEdgeMachinesMachine

BootstrapScript string: The bootstrap script.
ClusterId string: The ClusterId of NodePool.
ConditionTypes List<string>: The Condition of Status.
CreateClientToken string: The ClientToken when successfully created.
CreateTime string: The CreateTime of NodePool.
EdgeNodeType string: Edge node type.
Id string: The Id of NodePool.
Name string: The Name of NodePool.
Phase string: The Phase of Status.
Profile string: Edge: Edge node pool. If the return value is empty, it is the central node pool.
TtlTime int: The TTL time.
UpdateTime string: The UpdateTime time of NodePool.

BootstrapScript string: The bootstrap script.
ClusterId string: The ClusterId of NodePool.
ConditionTypes []string: The Condition of Status.
CreateClientToken string: The ClientToken when successfully created.
CreateTime string: The CreateTime of NodePool.
EdgeNodeType string: Edge node type.
Id string: The Id of NodePool.
Name string: The Name of NodePool.
Phase string: The Phase of Status.
Profile string: Edge: Edge node pool. If the return value is empty, it is the central node pool.
TtlTime int: The TTL time.
UpdateTime string: The UpdateTime time of NodePool.

bootstrapScript String: The bootstrap script.
clusterId String: The ClusterId of NodePool.
conditionTypes List<String>: The Condition of Status.
createClientToken String: The ClientToken when successfully created.
createTime String: The CreateTime of NodePool.
edgeNodeType String: Edge node type.
id String: The Id of NodePool.
name String: The Name of NodePool.
phase String: The Phase of Status.
profile String: Edge: Edge node pool. If the return value is empty, it is the central node pool.
ttlTime Integer: The TTL time.
updateTime String: The UpdateTime time of NodePool.

bootstrapScript string: The bootstrap script.
clusterId string: The ClusterId of NodePool.
conditionTypes string[]: The Condition of Status.
createClientToken string: The ClientToken when successfully created.
createTime string: The CreateTime of NodePool.
edgeNodeType string: Edge node type.
id string: The Id of NodePool.
name string: The Name of NodePool.
phase string: The Phase of Status.
profile string: Edge: Edge node pool. If the return value is empty, it is the central node pool.
ttlTime number: The TTL time.
updateTime string: The UpdateTime time of NodePool.

bootstrap_script str: The bootstrap script.
cluster_id str: The ClusterId of NodePool.
condition_types Sequence[str]: The Condition of Status.
create_client_token str: The ClientToken when successfully created.
create_time str: The CreateTime of NodePool.
edge_node_type str: Edge node type.
id str: The Id of NodePool.
name str: The Name of NodePool.
phase str: The Phase of Status.
profile str: Edge: Edge node pool. If the return value is empty, it is the central node pool.
ttl_time int: The TTL time.
update_time str: The UpdateTime time of NodePool.

bootstrapScript String: The bootstrap script.
clusterId String: The ClusterId of NodePool.
conditionTypes List<String>: The Condition of Status.
createClientToken String: The ClientToken when successfully created.
createTime String: The CreateTime of NodePool.
edgeNodeType String: Edge node type.
id String: The Id of NodePool.
name String: The Name of NodePool.
phase String: The Phase of Status.
profile String: Edge: Edge node pool. If the return value is empty, it is the central node pool.
ttlTime Number: The TTL time.
updateTime String: The UpdateTime time of NodePool.

GetBatchEdgeMachinesStatus

EdgeNodeStatusConditionType string: Indicates the status condition of the node pool in the active state. The value can be Progressing or Ok or VersionPartlyUpgraded or StockOut or LimitedByQuota or Balance or Degraded or ClusterVersionUpgrading or Cluster or ResourceCleanupFailed or Unknown or ClusterNotRunning or SetByProvider.
Phase string: The Phase of Status. The value can be Creating or Running or Updating or Deleting or Failed or Scaling.

EdgeNodeStatusConditionType string: Indicates the status condition of the node pool in the active state. The value can be Progressing or Ok or VersionPartlyUpgraded or StockOut or LimitedByQuota or Balance or Degraded or ClusterVersionUpgrading or Cluster or ResourceCleanupFailed or Unknown or ClusterNotRunning or SetByProvider.
Phase string: The Phase of Status. The value can be Creating or Running or Updating or Deleting or Failed or Scaling.

edgeNodeStatusConditionType String: Indicates the status condition of the node pool in the active state. The value can be Progressing or Ok or VersionPartlyUpgraded or StockOut or LimitedByQuota or Balance or Degraded or ClusterVersionUpgrading or Cluster or ResourceCleanupFailed or Unknown or ClusterNotRunning or SetByProvider.
phase String: The Phase of Status. The value can be Creating or Running or Updating or Deleting or Failed or Scaling.

edgeNodeStatusConditionType string: Indicates the status condition of the node pool in the active state. The value can be Progressing or Ok or VersionPartlyUpgraded or StockOut or LimitedByQuota or Balance or Degraded or ClusterVersionUpgrading or Cluster or ResourceCleanupFailed or Unknown or ClusterNotRunning or SetByProvider.
phase string: The Phase of Status. The value can be Creating or Running or Updating or Deleting or Failed or Scaling.

edge_node_status_condition_type str: Indicates the status condition of the node pool in the active state. The value can be Progressing or Ok or VersionPartlyUpgraded or StockOut or LimitedByQuota or Balance or Degraded or ClusterVersionUpgrading or Cluster or ResourceCleanupFailed or Unknown or ClusterNotRunning or SetByProvider.
phase str: The Phase of Status. The value can be Creating or Running or Updating or Deleting or Failed or Scaling.

edgeNodeStatusConditionType String: Indicates the status condition of the node pool in the active state. The value can be Progressing or Ok or VersionPartlyUpgraded or StockOut or LimitedByQuota or Balance or Degraded or ClusterVersionUpgrading or Cluster or ResourceCleanupFailed or Unknown or ClusterNotRunning or SetByProvider.
phase String: The Phase of Status. The value can be Creating or Running or Updating or Deleting or Failed or Scaling.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine/pulumi-volcengine

volcengine.veecp.getBatchEdgeMachines

On this page

On this page

Example Usage

Using getBatchEdgeMachines

getBatchEdgeMachines Result

Supporting Types

GetBatchEdgeMachinesMachine

GetBatchEdgeMachinesStatus

Package Details

On this page

On this page