All Products
Search

This Product

    Object Storage Service:get-symlink

    Document Center

    Object Storage Service:get-symlink

    Last Updated:Mar 20, 2026

    Queries the symbolic link of an object.

    Usage notes

    • Alibaba Cloud accounts have permission to query symbolic links by default. RAM users and Security Token Service (STS) users require the oss:GetObject permission. For details, see Attach a custom policy to a RAM user.

    • By default, get-symlink queries the current version of the symbolic link. Use --version-id to query a specific version.

    Command syntax

    ossutil api get-symlink --bucket <bucket-name> --key <object-key> [flags]
    ParameterTypeDescriptionExample
    --bucketstringName of the bucket.examplebucket
    --keystringFull path of the object (object key).examplelink
    --version-idstringVersion of the object to which the symbolic link points.CAEQNRiBgMClj7F1HiIDc
    Note

    get-symlink maps to the GetSymlink API operation. For the full parameter reference, see GetSymlink. For supported global flags, see Command-line options.

    Examples

    Query the symbolic link of examplelink in examplebucket

    ossutil api get-symlink --bucket examplebucket --key examplelink