Skip to main content

describe

Addedv0.1.x

This operation gets details and privileges of a role.

📘Notes

This command is available for Dedicated clusters only. You can run zilliz context set to switch among clusters.

Synopsis

zilliz role describe
--role <value>
[--output <json | table | text | yaml | csv]
[--no-header]
[--query <value>]
[--database <value>]

OPTIONS:

  • --role (string) -

    [REQUIRED]

    Indicates the role name.

  • --output, -o (string) -

    Indicates the output format. Possible values:

    • json,

    • table,

    • text,

    • yaml,

    • csv.

  • --no-header (boolean) -

    Indicates whether to omit the header row when the output is set to table or csv.

  • --query, -q (string) -

    Indicates a JMESPath expression to filter output.

  • --database (string) -

    Indicates a database name. The value defaults to default.

Example

zilliz role describe --role my_role