list-cname

Updated at:

Queries all CNAME records that are mapped to a bucket.

Usage note

By default, an Alibaba Cloud account has the permissions to query all CNAME records that are mapped to a bucket. The oss:ListCname permission is required to query CNAME records as a RAM user or by using STS. For more information, see Grant a custom policy.

Command syntax

ossutil api list-cname --bucket value [flags]

Parameter

Type

Description

--bucket

string

The name of the bucket.

Note
  • For an Agentic Bucket, the list-cname command operates in the same manner as for a standard bucket. The response may contain wildcard domain CNAME entries, which are identified by the IsWildCard element.

  • The list-cname command corresponds to the ListCname API operation. For more information about the parameters, see ListCname.

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

Examples

  • Query all CNAME records mapped to examplebucket.

    ossutil api list-cname --bucket examplebucket
  • Query all CNAME records mapped to examplebucket and display the result in JSON format.

    ossutil api list-cname --bucket examplebucket --output-format json
  • Query all CNAME records mapped to examplebucket and display the result in YAML format.

    ossutil api list-cname --bucket examplebucket --output-format yaml