Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. hbr
  5. getEcsBackupClients
Alibaba Cloud v3.54.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.hbr.getEcsBackupClients

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.54.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-alicloud

    This data source provides the Hbr Ecs File Backup Clients of the current Alibaba Cloud user.

    NOTE: Available in v1.132.0+.

    Example Usage

    Basic Usage

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

const default = alicloud.ecs.getInstances({
    nameRegex: "ecs_instance_name",
    status: "Running",
});
const ids = alicloud.hbr.getEcsBackupClients({
    ids: [defaultAlicloudHbrEcsBackupClient.id],
    instanceIds: [defaultAlicloudHbrEcsBackupClient.instanceId],
});
export const hbrEcsBackupClientId1 = ids.then(ids => ids.clients?.[0]?.id);

    import pulumi
import pulumi_alicloud as alicloud

default = alicloud.ecs.get_instances(name_regex="ecs_instance_name",
    status="Running")
ids = alicloud.hbr.get_ecs_backup_clients(ids=[default_alicloud_hbr_ecs_backup_client["id"]],
    instance_ids=[default_alicloud_hbr_ecs_backup_client["instanceId"]])
pulumi.export("hbrEcsBackupClientId1", ids.clients[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ecs.GetInstances(ctx, &ecs.GetInstancesArgs{
NameRegex: pulumi.StringRef("ecs_instance_name"),
Status: pulumi.StringRef("Running"),
}, nil);
if err != nil {
return err
}
ids, err := hbr.GetEcsBackupClients(ctx, &hbr.GetEcsBackupClientsArgs{
Ids: interface{}{
defaultAlicloudHbrEcsBackupClient.Id,
},
InstanceIds: interface{}{
defaultAlicloudHbrEcsBackupClient.InstanceId,
},
}, nil);
if err != nil {
return err
}
ctx.Export("hbrEcsBackupClientId1", ids.Clients[0].Id)
return nil
})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.Ecs.GetInstances.Invoke(new()
    {
        NameRegex = "ecs_instance_name",
        Status = "Running",
    });

    var ids = AliCloud.Hbr.GetEcsBackupClients.Invoke(new()
    {
        Ids = new[]
        {
            defaultAlicloudHbrEcsBackupClient.Id,
        },
        InstanceIds = new[]
        {
            defaultAlicloudHbrEcsBackupClient.InstanceId,
        },
    });

    return new Dictionary<string, object?>
    {
        ["hbrEcsBackupClientId1"] = ids.Apply(getEcsBackupClientsResult => getEcsBackupClientsResult.Clients[0]?.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetInstancesArgs;
import com.pulumi.alicloud.hbr.HbrFunctions;
import com.pulumi.alicloud.hbr.inputs.GetEcsBackupClientsArgs;
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 default = EcsFunctions.getInstances(GetInstancesArgs.builder()
            .nameRegex("ecs_instance_name")
            .status("Running")
            .build());

        final var ids = HbrFunctions.getEcsBackupClients(GetEcsBackupClientsArgs.builder()
            .ids(defaultAlicloudHbrEcsBackupClient.id())
            .instanceIds(defaultAlicloudHbrEcsBackupClient.instanceId())
            .build());

        ctx.export("hbrEcsBackupClientId1", ids.applyValue(getEcsBackupClientsResult -> getEcsBackupClientsResult.clients()[0].id()));
    }
}

    variables:
  default:
    fn::invoke:
      Function: alicloud:ecs:getInstances
      Arguments:
        nameRegex: ecs_instance_name
        status: Running
  ids:
    fn::invoke:
      Function: alicloud:hbr:getEcsBackupClients
      Arguments:
        ids:
          - ${defaultAlicloudHbrEcsBackupClient.id}
        instanceIds:
          - ${defaultAlicloudHbrEcsBackupClient.instanceId}
outputs:
  hbrEcsBackupClientId1: ${ids.clients[0].id}

    Using getEcsBackupClients

    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 getEcsBackupClients(args: GetEcsBackupClientsArgs, opts?: InvokeOptions): Promise<GetEcsBackupClientsResult>
function getEcsBackupClientsOutput(args: GetEcsBackupClientsOutputArgs, opts?: InvokeOptions): Output<GetEcsBackupClientsResult>
    def get_ecs_backup_clients(ids: Optional[Sequence[str]] = None,
                           instance_ids: Optional[Sequence[str]] = None,
                           output_file: Optional[str] = None,
                           status: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetEcsBackupClientsResult
def get_ecs_backup_clients_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           instance_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           output_file: Optional[pulumi.Input[str]] = None,
                           status: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetEcsBackupClientsResult]
    func GetEcsBackupClients(ctx *Context, args *GetEcsBackupClientsArgs, opts ...InvokeOption) (*GetEcsBackupClientsResult, error)
func GetEcsBackupClientsOutput(ctx *Context, args *GetEcsBackupClientsOutputArgs, opts ...InvokeOption) GetEcsBackupClientsResultOutput

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

    public static class GetEcsBackupClients 
{
    public static Task<GetEcsBackupClientsResult> InvokeAsync(GetEcsBackupClientsArgs args, InvokeOptions? opts = null)
    public static Output<GetEcsBackupClientsResult> Invoke(GetEcsBackupClientsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEcsBackupClientsResult> getEcsBackupClients(GetEcsBackupClientsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: alicloud:hbr/getEcsBackupClients:getEcsBackupClients
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Ecs Backup Client IDs.
    InstanceIds List<string>
    A list of ECS Instance IDs.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Status string
    The status of the resource. Valid values: ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, REGISTERED, STOPPED, UNINSTALLING, UNINSTALL_FAILED, UNKNOWN, UPGRADE_FAILED, UPGRADING.
    Ids []string
    A list of Ecs Backup Client IDs.
    InstanceIds []string
    A list of ECS Instance IDs.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Status string
    The status of the resource. Valid values: ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, REGISTERED, STOPPED, UNINSTALLING, UNINSTALL_FAILED, UNKNOWN, UPGRADE_FAILED, UPGRADING.
    ids List<String>
    A list of Ecs Backup Client IDs.
    instanceIds List<String>
    A list of ECS Instance IDs.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    status String
    The status of the resource. Valid values: ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, REGISTERED, STOPPED, UNINSTALLING, UNINSTALL_FAILED, UNKNOWN, UPGRADE_FAILED, UPGRADING.
    ids string[]
    A list of Ecs Backup Client IDs.
    instanceIds string[]
    A list of ECS Instance IDs.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    status string
    The status of the resource. Valid values: ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, REGISTERED, STOPPED, UNINSTALLING, UNINSTALL_FAILED, UNKNOWN, UPGRADE_FAILED, UPGRADING.
    ids Sequence[str]
    A list of Ecs Backup Client IDs.
    instance_ids Sequence[str]
    A list of ECS Instance IDs.
    output_file str
    File name where to save data source results (after running pulumi preview).
    status str
    The status of the resource. Valid values: ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, REGISTERED, STOPPED, UNINSTALLING, UNINSTALL_FAILED, UNKNOWN, UPGRADE_FAILED, UPGRADING.
    ids List<String>
    A list of Ecs Backup Client IDs.
    instanceIds List<String>
    A list of ECS Instance IDs.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    status String
    The status of the resource. Valid values: ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, REGISTERED, STOPPED, UNINSTALLING, UNINSTALL_FAILED, UNKNOWN, UPGRADE_FAILED, UPGRADING.

    getEcsBackupClients Result

    The following output properties are available:

    Clients List<Pulumi.AliCloud.Hbr.Outputs.GetEcsBackupClientsClient>
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    InstanceIds List<string>
    OutputFile string
    Status string
    Clients []GetEcsBackupClientsClient
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    InstanceIds []string
    OutputFile string
    Status string
    clients List<GetEcsBackupClientsClient>
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    instanceIds List<String>
    outputFile String
    status String
    clients GetEcsBackupClientsClient[]
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    instanceIds string[]
    outputFile string
    status string
    clients Sequence[GetEcsBackupClientsClient]
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    instance_ids Sequence[str]
    output_file str
    status str
    clients List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    instanceIds List<String>
    outputFile String
    status String

    Supporting Types

    GetEcsBackupClientsClient

    ArchType string
    The system architecture of client, only the ECS File Backup Client is available. Valid values: AMD64 , 386.
    BackupStatus string
    Client protected status. Valid values: UNPROTECTED, PROTECTED.
    ClientType string
    The type of client. Valid values: ECS_CLIENT (ECS File Backup Client).
    ClientVersion string
    The version of client.
    CreateTime string
    The creation time of client. Unix time in seconds.
    DataNetworkType string
    The data plane access point type. Valid Values: PUBLIC, VPC, CLASSIC.
    DataProxySetting string
    The data plane proxy settings. Valid Values: DISABLE, USE_CONTROL_PROXY, CUSTOM.
    EcsBackupClientId string
    The first ID of the resource.
    Hostname string
    The hostname of ECS instance.
    Id string
    The ID of the Ecs Backup Client.
    InstanceId string
    The ID of ECS instance. When the client type is ECS file backup client, it indicates the ID of ECS instance. When the client type is a local file backup client, it is a hardware fingerprint generated based on system information.
    InstanceName string
    The name of ECS instance.
    LastHeartBeatTime string
    The last heartbeat time of client. Unix Time Seconds.
    MaxClientVersion string
    The latest version of client.
    MaxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    MaxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    OsType string
    The operating system type of client, only the ECS File Backup Client is available. Valid values: windows, linux.
    PrivateIpv4 string
    Intranet IP address of the instance, only available for ECS file backup client.
    ProxyHost string
    Custom data plane proxy server host address.
    ProxyPassword string
    The password of custom data plane proxy server.
    ProxyPort string
    Custom data plane proxy server host port.
    ProxyUser string
    The username of custom data plane proxy server.
    Status string
    The status of the resource.
    UpdatedTime string
    The update time of client. Unix Time Seconds.
    UseHttps bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    ZoneId string
    The ID of Zone.
    ArchType string
    The system architecture of client, only the ECS File Backup Client is available. Valid values: AMD64 , 386.
    BackupStatus string
    Client protected status. Valid values: UNPROTECTED, PROTECTED.
    ClientType string
    The type of client. Valid values: ECS_CLIENT (ECS File Backup Client).
    ClientVersion string
    The version of client.
    CreateTime string
    The creation time of client. Unix time in seconds.
    DataNetworkType string
    The data plane access point type. Valid Values: PUBLIC, VPC, CLASSIC.
    DataProxySetting string
    The data plane proxy settings. Valid Values: DISABLE, USE_CONTROL_PROXY, CUSTOM.
    EcsBackupClientId string
    The first ID of the resource.
    Hostname string
    The hostname of ECS instance.
    Id string
    The ID of the Ecs Backup Client.
    InstanceId string
    The ID of ECS instance. When the client type is ECS file backup client, it indicates the ID of ECS instance. When the client type is a local file backup client, it is a hardware fingerprint generated based on system information.
    InstanceName string
    The name of ECS instance.
    LastHeartBeatTime string
    The last heartbeat time of client. Unix Time Seconds.
    MaxClientVersion string
    The latest version of client.
    MaxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    MaxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    OsType string
    The operating system type of client, only the ECS File Backup Client is available. Valid values: windows, linux.
    PrivateIpv4 string
    Intranet IP address of the instance, only available for ECS file backup client.
    ProxyHost string
    Custom data plane proxy server host address.
    ProxyPassword string
    The password of custom data plane proxy server.
    ProxyPort string
    Custom data plane proxy server host port.
    ProxyUser string
    The username of custom data plane proxy server.
    Status string
    The status of the resource.
    UpdatedTime string
    The update time of client. Unix Time Seconds.
    UseHttps bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    ZoneId string
    The ID of Zone.
    archType String
    The system architecture of client, only the ECS File Backup Client is available. Valid values: AMD64 , 386.
    backupStatus String
    Client protected status. Valid values: UNPROTECTED, PROTECTED.
    clientType String
    The type of client. Valid values: ECS_CLIENT (ECS File Backup Client).
    clientVersion String
    The version of client.
    createTime String
    The creation time of client. Unix time in seconds.
    dataNetworkType String
    The data plane access point type. Valid Values: PUBLIC, VPC, CLASSIC.
    dataProxySetting String
    The data plane proxy settings. Valid Values: DISABLE, USE_CONTROL_PROXY, CUSTOM.
    ecsBackupClientId String
    The first ID of the resource.
    hostname String
    The hostname of ECS instance.
    id String
    The ID of the Ecs Backup Client.
    instanceId String
    The ID of ECS instance. When the client type is ECS file backup client, it indicates the ID of ECS instance. When the client type is a local file backup client, it is a hardware fingerprint generated based on system information.
    instanceName String
    The name of ECS instance.
    lastHeartBeatTime String
    The last heartbeat time of client. Unix Time Seconds.
    maxClientVersion String
    The latest version of client.
    maxCpuCore String
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker String
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    osType String
    The operating system type of client, only the ECS File Backup Client is available. Valid values: windows, linux.
    privateIpv4 String
    Intranet IP address of the instance, only available for ECS file backup client.
    proxyHost String
    Custom data plane proxy server host address.
    proxyPassword String
    The password of custom data plane proxy server.
    proxyPort String
    Custom data plane proxy server host port.
    proxyUser String
    The username of custom data plane proxy server.
    status String
    The status of the resource.
    updatedTime String
    The update time of client. Unix Time Seconds.
    useHttps Boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    zoneId String
    The ID of Zone.
    archType string
    The system architecture of client, only the ECS File Backup Client is available. Valid values: AMD64 , 386.
    backupStatus string
    Client protected status. Valid values: UNPROTECTED, PROTECTED.
    clientType string
    The type of client. Valid values: ECS_CLIENT (ECS File Backup Client).
    clientVersion string
    The version of client.
    createTime string
    The creation time of client. Unix time in seconds.
    dataNetworkType string
    The data plane access point type. Valid Values: PUBLIC, VPC, CLASSIC.
    dataProxySetting string
    The data plane proxy settings. Valid Values: DISABLE, USE_CONTROL_PROXY, CUSTOM.
    ecsBackupClientId string
    The first ID of the resource.
    hostname string
    The hostname of ECS instance.
    id string
    The ID of the Ecs Backup Client.
    instanceId string
    The ID of ECS instance. When the client type is ECS file backup client, it indicates the ID of ECS instance. When the client type is a local file backup client, it is a hardware fingerprint generated based on system information.
    instanceName string
    The name of ECS instance.
    lastHeartBeatTime string
    The last heartbeat time of client. Unix Time Seconds.
    maxClientVersion string
    The latest version of client.
    maxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    osType string
    The operating system type of client, only the ECS File Backup Client is available. Valid values: windows, linux.
    privateIpv4 string
    Intranet IP address of the instance, only available for ECS file backup client.
    proxyHost string
    Custom data plane proxy server host address.
    proxyPassword string
    The password of custom data plane proxy server.
    proxyPort string
    Custom data plane proxy server host port.
    proxyUser string
    The username of custom data plane proxy server.
    status string
    The status of the resource.
    updatedTime string
    The update time of client. Unix Time Seconds.
    useHttps boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    zoneId string
    The ID of Zone.
    arch_type str
    The system architecture of client, only the ECS File Backup Client is available. Valid values: AMD64 , 386.
    backup_status str
    Client protected status. Valid values: UNPROTECTED, PROTECTED.
    client_type str
    The type of client. Valid values: ECS_CLIENT (ECS File Backup Client).
    client_version str
    The version of client.
    create_time str
    The creation time of client. Unix time in seconds.
    data_network_type str
    The data plane access point type. Valid Values: PUBLIC, VPC, CLASSIC.
    data_proxy_setting str
    The data plane proxy settings. Valid Values: DISABLE, USE_CONTROL_PROXY, CUSTOM.
    ecs_backup_client_id str
    The first ID of the resource.
    hostname str
    The hostname of ECS instance.
    id str
    The ID of the Ecs Backup Client.
    instance_id str
    The ID of ECS instance. When the client type is ECS file backup client, it indicates the ID of ECS instance. When the client type is a local file backup client, it is a hardware fingerprint generated based on system information.
    instance_name str
    The name of ECS instance.
    last_heart_beat_time str
    The last heartbeat time of client. Unix Time Seconds.
    max_client_version str
    The latest version of client.
    max_cpu_core str
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    max_worker str
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    os_type str
    The operating system type of client, only the ECS File Backup Client is available. Valid values: windows, linux.
    private_ipv4 str
    Intranet IP address of the instance, only available for ECS file backup client.
    proxy_host str
    Custom data plane proxy server host address.
    proxy_password str
    The password of custom data plane proxy server.
    proxy_port str
    Custom data plane proxy server host port.
    proxy_user str
    The username of custom data plane proxy server.
    status str
    The status of the resource.
    updated_time str
    The update time of client. Unix Time Seconds.
    use_https bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    zone_id str
    The ID of Zone.
    archType String
    The system architecture of client, only the ECS File Backup Client is available. Valid values: AMD64 , 386.
    backupStatus String
    Client protected status. Valid values: UNPROTECTED, PROTECTED.
    clientType String
    The type of client. Valid values: ECS_CLIENT (ECS File Backup Client).
    clientVersion String
    The version of client.
    createTime String
    The creation time of client. Unix time in seconds.
    dataNetworkType String
    The data plane access point type. Valid Values: PUBLIC, VPC, CLASSIC.
    dataProxySetting String
    The data plane proxy settings. Valid Values: DISABLE, USE_CONTROL_PROXY, CUSTOM.
    ecsBackupClientId String
    The first ID of the resource.
    hostname String
    The hostname of ECS instance.
    id String
    The ID of the Ecs Backup Client.
    instanceId String
    The ID of ECS instance. When the client type is ECS file backup client, it indicates the ID of ECS instance. When the client type is a local file backup client, it is a hardware fingerprint generated based on system information.
    instanceName String
    The name of ECS instance.
    lastHeartBeatTime String
    The last heartbeat time of client. Unix Time Seconds.
    maxClientVersion String
    The latest version of client.
    maxCpuCore String
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker String
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    osType String
    The operating system type of client, only the ECS File Backup Client is available. Valid values: windows, linux.
    privateIpv4 String
    Intranet IP address of the instance, only available for ECS file backup client.
    proxyHost String
    Custom data plane proxy server host address.
    proxyPassword String
    The password of custom data plane proxy server.
    proxyPort String
    Custom data plane proxy server host port.
    proxyUser String
    The username of custom data plane proxy server.
    status String
    The status of the resource.
    updatedTime String
    The update time of client. Unix Time Seconds.
    useHttps Boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    zoneId String
    The ID of Zone.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.54.0 published on Wednesday, Apr 24, 2024 by Pulumi
    pulumi/pulumi-alicloud