All Products
Search

This Product

    Object Storage Service:get-symlink

    Document Center

    Object Storage Service:get-symlink

    Last Updated:Sep 21, 2026

    The command get-symlink is used to query the symbolic link of an object.

    Usage notes

    • By default, an Alibaba Cloud account has the permissions to query the symbolic link of an object. Making query requests as a RAM user or by using Security Token Service (STS) requires oss:GetObject permissions. For more information, see Grant a custom policy.

    • By default, the command get-symlink queries the current version of the symbolic link. You can specify a version ID in the request to query the specified version.

    Command syntax

    ossutil api get-symlink --bucket value --key value [flags]

    Parameter

    Type

    Description

    --bucket

    string

    Name of the bucket.

    --key

    string

    Full path of the object.

    --version-id

    string

    Version of the object to which the symbolic link points.
    Note

    • The get-symlink command corresponds to the GetSymlink operation. For more information about the parameters in the GetSymlink operation, see GetSymlink.

    • For more information about supported global command-line options, see Command-line options.

    Example

    Query the symbolic link of examplelink.

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