Re: [PATCH proxmox-backup 4/7] client: add 'instance-id' sub-command

[Christian Ebner <c.ebner@proxmox.com>]

On 4/13/26 2:10 PM, Lukas Wagner wrote:
> This allows users to query the instance-id from the

comment: IMHO using `instance-id` also on the client side is misleading, 
maybe `pbs-instance-id`, `host-instance-id` or `server-insance-id`? It 
should however be clear that this is not an `instance-id` from the 
client itself or the host it is executed on.

Below should be adapted accordingly.

> proxmox-backup-client tool. This will also be used by the PBS client in
> PVE to lookup the instance-id from a yet to be introduced API endpoint
> that returns the instance-id for a given PBS storage.
> 
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
>   proxmox-backup-client/src/main.rs | 41 +++++++++++++++++++++++++++++--
>   1 file changed, 39 insertions(+), 2 deletions(-)
> 
> diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs
> index 2ada87bdd..9f4a82e26 100644
> --- a/proxmox-backup-client/src/main.rs
> +++ b/proxmox-backup-client/src/main.rs
> @@ -25,8 +25,8 @@ use pxar::accessor::{MaybeReady, ReadAt, ReadAtOperation};
>   
>   use pbs_api_types::{
>       ArchiveType, Authid, BackupArchiveName, BackupDir, BackupGroup, BackupNamespace, BackupPart,
> -    BackupType, ClientRateLimitConfig, CryptMode, Fingerprint, GroupListItem, PathPattern,
> -    PruneJobOptions, PruneListItem, RateLimitConfig, SnapshotListItem, StorageStatus,
> +    BackupType, ClientRateLimitConfig, CryptMode, Fingerprint, GroupListItem, InstanceId,
> +    PathPattern, PruneJobOptions, PruneListItem, RateLimitConfig, SnapshotListItem, StorageStatus,
>       BACKUP_ID_SCHEMA, BACKUP_NAMESPACE_SCHEMA, BACKUP_TIME_SCHEMA, BACKUP_TYPE_SCHEMA,
>       CATALOG_NAME, ENCRYPTED_KEY_BLOB_NAME, MANIFEST_BLOB_NAME,
>   };
> @@ -139,6 +139,39 @@ fn record_repository(repo: &BackupRepository) {
>       );
>   }
>   
> +#[api(
> +    input: {
> +        properties: {
> +            repository: {
> +                schema: REPO_URL_SCHEMA,
> +                optional: true,
> +            },
> +            "output-format": {
> +                schema: OUTPUT_FORMAT,
> +                optional: true,
> +            },
> +        },
> +    },
> +)]
> +/// Start garbage collection for a specific repository.
> +async fn get_instance_id(param: Value) -> Result<Value, Error> {
> +    let repo = extract_repository_from_value(&param)?;
> +    let output_format = get_output_format(&param);
> +    let client = connect(&repo)?;
> +
> +    let path = format!("api2/json/nodes/localhost/instance-id");

nit: can use the plain `str`, no need to instantiate a `String` here.

> +    let mut result = client.get(&path, None).await?;
> +
> +    let id: InstanceId = serde_json::from_value(result["data"].take())?;
> +
> +    if output_format == "text" {
> +        println!("instance-id: {}", id.instance_id);
> +    } else {
> +        format_and_print_result(&id, &output_format);
> +    }
> +    Ok(Value::Null)
> +}
> +
>   async fn api_datastore_list_snapshots(
>       client: &HttpClient,
>       store: &str,
> @@ -2076,6 +2109,9 @@ fn main() {
>       let version_cmd_def =
>           CliCommand::new(&API_METHOD_API_VERSION).completion_cb("repository", complete_repository);
>   
> +    let instance_id_cmd_def = CliCommand::new(&API_METHOD_GET_INSTANCE_ID)
> +        .completion_cb("repository", complete_repository);
> +
>       let change_owner_cmd_def = CliCommand::new(&API_METHOD_CHANGE_BACKUP_OWNER)
>           .arg_param(&["group", "new-owner"])
>           .completion_cb("ns", complete_namespace)
> @@ -2086,6 +2122,7 @@ fn main() {
>       let cmd_def = CliCommandMap::new()
>           .insert("backup", backup_cmd_def)
>           .insert("garbage-collect", garbage_collect_cmd_def)
> +        .insert("instance-id", instance_id_cmd_def)
>           .insert("list", list_cmd_def)
>           .insert("login", login_cmd_def)
>           .insert("logout", logout_cmd_def)