This topic describes the fields and operators available for OSS scalar retrieval.
Notes
Simple queries support the following operators: eq (equal to), gt (greater than), gte (greater than or equal to), lt (less than), lte (less than or equal to), match (fuzzy query), and prefix (prefix query). Aggregate operations support the following operators: min (minimum), max (maximum), average (average), sum (sum), count (count), distinct (deduplicated count), and group (grouped count).
To search for files using the
OSSUserMeta.*field, replace the asterisk (*) with the key of the user-defined metadata. The system searches for files based on the key-value pair of the user-defined metadata. The key is case-insensitive, and the value is case-sensitive.For example, you can search for files with the user-defined metadata
x-oss-meta-location=hangzhouby setting the query condition to{"Field": "OSSUserMeta.x-oss-meta-location", "Value": "hangzhou", "Operation": "eq"}.To search for files using the
OSSTagging.*field, replace the asterisk (*) with the key of the object tag. The system searches for files based on the key-value pair of the object tag. Both the key and value of the object tag are case-sensitive.For example, to search for files that have the tag
owner=John, set the query condition to{"Field": "OSSTagging.owner", "Value": "John", "Operation": "eq"}.
Support list
The following table lists the fields available for simple queries, aggregate operations, and sorting. The table also specifies the operators supported by each field.
In the table, ✓ indicates that the field supports the operator, and × indicates that the field does not support the operator.
Field | Description | Operators (in simple query conditions) | Operators (in aggregate operations) | Sort | |||
eq, gt, gte, lt, lte | match | prefix | min, max, sum, average | count, distinct, group | |||
ETag | Identifies the content of the object. | ✓ | × | ✓ | × | ✓ | ✓ |
FileModifiedTime | The last modified time of the object. | ✓ | × | × | × | ✓ | ✓ |
Filename | The name of the object, including the full path and filename. | ✓ | ✓ | ✓ | × | ✓ | ✓ |
ObjectACL | The access control list (ACL) of the object. | ✓ | × | ✓ | × | ✓ | ✓ |
OSSCRC64 | The 64-bit CRC-64 value of the object. | ✓ | × | ✓ | × | ✓ | ✓ |
OSSObjectType | The type of the object. | ✓ | × | ✓ | × | ✓ | ✓ |
OSSStorageClass | The storage class of the object. | ✓ | × | ✓ | × | ✓ | ✓ |
OSSTagging.* | The object tag. | ✓ | × | ✓ | × | × | × |
OSSTaggingCount | The number of object tags. | ✓ | × | × | ✓ | ✓ | ✓ |
Size | The size of the object. | ✓ | × | × | ✓ | ✓ | ✓ |