Alibaba Cloud v3.88.0 published on Saturday, Nov 1, 2025 by Pulumi
alicloud.hbr.getEcsBackupClients
Start a Neo task
Explain and create an alicloud.hbr.getEcsBackupClients resource
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.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)
public static Output<GetEcsBackupClientsResult> getEcsBackupClients(GetEcsBackupClientsArgs args, InvokeOptions options)
fn::invoke:
function: alicloud:hbr/getEcsBackupClients:getEcsBackupClients
arguments:
# arguments dictionaryThe following arguments are supported:
- Ids List<string>
- A list of Ecs Backup Client IDs.
- Instance
Ids List<string> - A list of ECS Instance IDs.
- Output
File 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.
- Instance
Ids []string - A list of ECS Instance IDs.
- Output
File 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.
- instance
Ids List<String> - A list of ECS Instance IDs.
- output
File 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.
- instance
Ids string[] - A list of ECS Instance IDs.
- output
File 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.
- instance
Ids List<String> - A list of ECS Instance IDs.
- output
File 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.
Ali Cloud. Hbr. Outputs. Get Ecs Backup Clients Client> - Id string
- The provider-assigned unique ID for this managed resource.
- Ids List<string>
- Instance
Ids List<string> - Output
File string - Status string
- Clients
[]Get
Ecs Backup Clients Client - Id string
- The provider-assigned unique ID for this managed resource.
- Ids []string
- Instance
Ids []string - Output
File string - Status string
- clients
List<Get
Ecs Backup Clients Client> - id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- instance
Ids List<String> - output
File String - status String
- clients
Get
Ecs Backup Clients Client[] - id string
- The provider-assigned unique ID for this managed resource.
- ids string[]
- instance
Ids string[] - output
File string - status string
- clients
Sequence[Get
Ecs Backup Clients Client] - 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>
- instance
Ids List<String> - output
File String - status String
Supporting Types
GetEcsBackupClientsClient
- Arch
Type string - The system architecture of client, only the ECS File Backup Client is available. Valid values:
AMD64,386. - Backup
Status string - Client protected status. Valid values:
UNPROTECTED,PROTECTED. - Client
Type string - The type of client. Valid values:
ECS_CLIENT(ECS File Backup Client). - Client
Version string - The version of client.
- Create
Time string - The creation time of client. Unix time in seconds.
- Data
Network stringType - The data plane access point type. Valid Values:
PUBLIC,VPC,CLASSIC. - Data
Proxy stringSetting - The data plane proxy settings. Valid Values:
DISABLE,USE_CONTROL_PROXY,CUSTOM.USE_CONTROL_PROXY(Default, the same with control plane)CUSTOM(Custom configuration items for the HTTP protocol).
- Ecs
Backup stringClient Id - The first ID of the resource.
- Hostname string
- The hostname of ECS instance.
- Id string
- The ID of the Ecs Backup Client.
- Instance
Id 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.
- Instance
Name string - The name of ECS instance.
- Last
Heart stringBeat Time - The last heartbeat time of client. Unix Time Seconds.
- Max
Client stringVersion - The latest version of client.
- Max
Cpu stringCore - The number of CPU cores used by a single backup task, 0 means no restrictions.
- Max
Worker string - The number of concurrent jobs for a single backup task, 0 means no restrictions.
- Os
Type string - The operating system type of client, only the ECS File Backup Client is available. Valid values:
windows,linux. - Private
Ipv4 string - Intranet IP address of the instance, only available for ECS file backup client.
- Proxy
Host string - Custom data plane proxy server host address.
- Proxy
Password string - The password of custom data plane proxy server.
- Proxy
Port string - Custom data plane proxy server host port.
- Proxy
User string - The username of custom data plane proxy server.
- Status string
- The status of the resource.
- Updated
Time string - The update time of client. Unix Time Seconds.
- Use
Https bool - Indicates whether to use the HTTPS protocol. Valid values:
true,false. - Zone
Id string - The ID of Zone.
- Arch
Type string - The system architecture of client, only the ECS File Backup Client is available. Valid values:
AMD64,386. - Backup
Status string - Client protected status. Valid values:
UNPROTECTED,PROTECTED. - Client
Type string - The type of client. Valid values:
ECS_CLIENT(ECS File Backup Client). - Client
Version string - The version of client.
- Create
Time string - The creation time of client. Unix time in seconds.
- Data
Network stringType - The data plane access point type. Valid Values:
PUBLIC,VPC,CLASSIC. - Data
Proxy stringSetting - The data plane proxy settings. Valid Values:
DISABLE,USE_CONTROL_PROXY,CUSTOM.USE_CONTROL_PROXY(Default, the same with control plane)CUSTOM(Custom configuration items for the HTTP protocol).
- Ecs
Backup stringClient Id - The first ID of the resource.
- Hostname string
- The hostname of ECS instance.
- Id string
- The ID of the Ecs Backup Client.
- Instance
Id 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.
- Instance
Name string - The name of ECS instance.
- Last
Heart stringBeat Time - The last heartbeat time of client. Unix Time Seconds.
- Max
Client stringVersion - The latest version of client.
- Max
Cpu stringCore - The number of CPU cores used by a single backup task, 0 means no restrictions.
- Max
Worker string - The number of concurrent jobs for a single backup task, 0 means no restrictions.
- Os
Type string - The operating system type of client, only the ECS File Backup Client is available. Valid values:
windows,linux. - Private
Ipv4 string - Intranet IP address of the instance, only available for ECS file backup client.
- Proxy
Host string - Custom data plane proxy server host address.
- Proxy
Password string - The password of custom data plane proxy server.
- Proxy
Port string - Custom data plane proxy server host port.
- Proxy
User string - The username of custom data plane proxy server.
- Status string
- The status of the resource.
- Updated
Time string - The update time of client. Unix Time Seconds.
- Use
Https bool - Indicates whether to use the HTTPS protocol. Valid values:
true,false. - Zone
Id string - The ID of Zone.
- arch
Type String - The system architecture of client, only the ECS File Backup Client is available. Valid values:
AMD64,386. - backup
Status String - Client protected status. Valid values:
UNPROTECTED,PROTECTED. - client
Type String - The type of client. Valid values:
ECS_CLIENT(ECS File Backup Client). - client
Version String - The version of client.
- create
Time String - The creation time of client. Unix time in seconds.
- data
Network StringType - The data plane access point type. Valid Values:
PUBLIC,VPC,CLASSIC. - data
Proxy StringSetting - The data plane proxy settings. Valid Values:
DISABLE,USE_CONTROL_PROXY,CUSTOM.USE_CONTROL_PROXY(Default, the same with control plane)CUSTOM(Custom configuration items for the HTTP protocol).
- ecs
Backup StringClient Id - The first ID of the resource.
- hostname String
- The hostname of ECS instance.
- id String
- The ID of the Ecs Backup Client.
- instance
Id 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.
- instance
Name String - The name of ECS instance.
- last
Heart StringBeat Time - The last heartbeat time of client. Unix Time Seconds.
- max
Client StringVersion - The latest version of client.
- max
Cpu StringCore - The number of CPU cores used by a single backup task, 0 means no restrictions.
- max
Worker String - The number of concurrent jobs for a single backup task, 0 means no restrictions.
- os
Type String - The operating system type of client, only the ECS File Backup Client is available. Valid values:
windows,linux. - private
Ipv4 String - Intranet IP address of the instance, only available for ECS file backup client.
- proxy
Host String - Custom data plane proxy server host address.
- proxy
Password String - The password of custom data plane proxy server.
- proxy
Port String - Custom data plane proxy server host port.
- proxy
User String - The username of custom data plane proxy server.
- status String
- The status of the resource.
- updated
Time String - The update time of client. Unix Time Seconds.
- use
Https Boolean - Indicates whether to use the HTTPS protocol. Valid values:
true,false. - zone
Id String - The ID of Zone.
- arch
Type string - The system architecture of client, only the ECS File Backup Client is available. Valid values:
AMD64,386. - backup
Status string - Client protected status. Valid values:
UNPROTECTED,PROTECTED. - client
Type string - The type of client. Valid values:
ECS_CLIENT(ECS File Backup Client). - client
Version string - The version of client.
- create
Time string - The creation time of client. Unix time in seconds.
- data
Network stringType - The data plane access point type. Valid Values:
PUBLIC,VPC,CLASSIC. - data
Proxy stringSetting - The data plane proxy settings. Valid Values:
DISABLE,USE_CONTROL_PROXY,CUSTOM.USE_CONTROL_PROXY(Default, the same with control plane)CUSTOM(Custom configuration items for the HTTP protocol).
- ecs
Backup stringClient Id - The first ID of the resource.
- hostname string
- The hostname of ECS instance.
- id string
- The ID of the Ecs Backup Client.
- instance
Id 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.
- instance
Name string - The name of ECS instance.
- last
Heart stringBeat Time - The last heartbeat time of client. Unix Time Seconds.
- max
Client stringVersion - The latest version of client.
- max
Cpu stringCore - The number of CPU cores used by a single backup task, 0 means no restrictions.
- max
Worker string - The number of concurrent jobs for a single backup task, 0 means no restrictions.
- os
Type string - The operating system type of client, only the ECS File Backup Client is available. Valid values:
windows,linux. - private
Ipv4 string - Intranet IP address of the instance, only available for ECS file backup client.
- proxy
Host string - Custom data plane proxy server host address.
- proxy
Password string - The password of custom data plane proxy server.
- proxy
Port string - Custom data plane proxy server host port.
- proxy
User string - The username of custom data plane proxy server.
- status string
- The status of the resource.
- updated
Time string - The update time of client. Unix Time Seconds.
- use
Https boolean - Indicates whether to use the HTTPS protocol. Valid values:
true,false. - zone
Id 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_ strtype - The data plane access point type. Valid Values:
PUBLIC,VPC,CLASSIC. - data_
proxy_ strsetting - The data plane proxy settings. Valid Values:
DISABLE,USE_CONTROL_PROXY,CUSTOM.USE_CONTROL_PROXY(Default, the same with control plane)CUSTOM(Custom configuration items for the HTTP protocol).
- ecs_
backup_ strclient_ id - 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_ strbeat_ time - The last heartbeat time of client. Unix Time Seconds.
- max_
client_ strversion - The latest version of client.
- max_
cpu_ strcore - 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.
- arch
Type String - The system architecture of client, only the ECS File Backup Client is available. Valid values:
AMD64,386. - backup
Status String - Client protected status. Valid values:
UNPROTECTED,PROTECTED. - client
Type String - The type of client. Valid values:
ECS_CLIENT(ECS File Backup Client). - client
Version String - The version of client.
- create
Time String - The creation time of client. Unix time in seconds.
- data
Network StringType - The data plane access point type. Valid Values:
PUBLIC,VPC,CLASSIC. - data
Proxy StringSetting - The data plane proxy settings. Valid Values:
DISABLE,USE_CONTROL_PROXY,CUSTOM.USE_CONTROL_PROXY(Default, the same with control plane)CUSTOM(Custom configuration items for the HTTP protocol).
- ecs
Backup StringClient Id - The first ID of the resource.
- hostname String
- The hostname of ECS instance.
- id String
- The ID of the Ecs Backup Client.
- instance
Id 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.
- instance
Name String - The name of ECS instance.
- last
Heart StringBeat Time - The last heartbeat time of client. Unix Time Seconds.
- max
Client StringVersion - The latest version of client.
- max
Cpu StringCore - The number of CPU cores used by a single backup task, 0 means no restrictions.
- max
Worker String - The number of concurrent jobs for a single backup task, 0 means no restrictions.
- os
Type String - The operating system type of client, only the ECS File Backup Client is available. Valid values:
windows,linux. - private
Ipv4 String - Intranet IP address of the instance, only available for ECS file backup client.
- proxy
Host String - Custom data plane proxy server host address.
- proxy
Password String - The password of custom data plane proxy server.
- proxy
Port String - Custom data plane proxy server host port.
- proxy
User String - The username of custom data plane proxy server.
- status String
- The status of the resource.
- updated
Time String - The update time of client. Unix Time Seconds.
- use
Https Boolean - Indicates whether to use the HTTPS protocol. Valid values:
true,false. - zone
Id 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
alicloudTerraform Provider.
