This topic describes fields and operators that are supported in simple queries, aggregation operations, and geographic queries.
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), nested (nested query), exist (existence query), match-phrase (match-phrase query), and prefix (prefix query). Aggregation operations support the following operators: min (minimum), max (maximum), average (the average operator, which is similar to the AVG function in SQL), sum (summation), count (counting), distinct (the distinct operator, which counts the number of distinct values in a row and is similar to the DISTINCT keyword in SQL), and group (group counting, which may produce a result with an error if the number of groups is too large. The distinct operator returns an approximate value: a value that is close to the accurate value if the number of rows to which the operator is applied is less than 10,000 or a value that has an error of approximately 2% if the number of rows to which the operator is applied is greater than or equal to 100 million.
Geographic queries support the LatLong field, on which the following operators can be used:
geo-distance: searches within the specified distance (radius) of a center point. Operands of the operator use the "latitude,longitude;radiusInMeters" format. For example, "33,119;1000" specifies that the query is performed within a radius of 1,000 meters from the "33,119" center point.
geo-bounding-box: searches within a rectangle defined by latitudes and longitudes of the top-left and bottom-right vertexes. Operands of the operator use the "topLeftLatitude,topLeftLongitude;bottomRightLatitude,bottomRightLongitude" format. For example, "35,118.5;33.5,120" specifies that the query is performed within the rectangle that is defined by the top-left vertex (35,118.5) and the bottom-right vertex (33.5,120).
geo-polygon: searches within a polygon that is defined by the latitudes and longitudes of at least three points in the "latitude,longitude;latitude,longitude;latitude,longitude;..." format. For example, "33,118;33,120;35,120;35,118" specifies that the query is performed within the polygon defined by the following points: 33,118, 33,120, 35,120, and 35,118.
If the Customlabels field is used to query objects, the query is performed based on the key-value tags of the objects. The keys and values of object tags are not case-sensitive.
For example, to search for files that have the tag
Bucket=examplebucket, set the query condition to{"Bucket": "examplebucket"}.When you use the OSSTagging.* field to query objects, replace the asterisk (*) with the key of the object tag. The system queries the object based on the key-value pair of the object tag. The keys and values of object tags 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"}.When you use the OSSUserMeta.* field to query objects, replace the asterisk (*) with the key of the user metadata. The system queries objects based on the key and value of the user metadata header. The key of the user metadata is not case-sensitive. However, its value is case-sensitive.
For example, to search for files that have the user-defined metadata
x-oss-meta-location=hangzhou, set the query condition to{"Field": "OSSUserMeta.x-oss-meta-location", "Value": "hangzhou", "Operation": "eq"}.
List of supported fields and operators
The following table describes the fields and operators that are supported in simple queries and aggregation operations.
Fields marked with a number sign superscript (#) are reserved and currently unavailable.
Simple query
Field | Operator | Does this support sorting? | ||||
eq, gt, gte, lt, and lte | match-phrase | prefix | nested | exist | ||
AccessControlAllowOrigin | Support | Not supported | Support | Not supported | Not supported | Support |
AccessControlRequestMethod | Support | Not supported | Supported | Not supported | Not supported | Support |
Addresses.AddressLine | Not supported | Support | Not supported | Supported | Support | Not supported |
Addresses.City | Support | Not supported | Supported | Supported | Supported | Not supported |
Addresses.Country | Support | Not supported | Supported | Support | Support | Not supported |
Addresses.District | Support | Not supported | Supported | Support | Support | Not supported |
Addresses.Language | Support | Not supported | Support | Supported | Supported | Not supported |
Addresses.Province | Support | Not supported | Supported | Supported | Support | Not supported |
Addresses.Township | Support | Not supported | Support | Support | Supported | Not supported |
Album | Supported | Not supported | Supported | Not supported | Not supported | Support |
AlbumArtist | Supported | Not supported | Support | Not supported | Not supported | Supported |
Artist# | Support | Not supported | Supported | Not supported | Not supported | Supported |
AudioStreams.CodecName | Supported | Not supported | Support | Support | Support | Not supported |
AudioStreams.Language | Support | Not supported | Supported | Support | Support | Not supported |
AudioStreams.Lyric | Not supported | Support | Not supported | Support | Support | Not supported |
Bitrate | Support | Not supported | Not supported | Not supported | Not supported | Support |
Bodies.Confidence | Supported | Not supported | Not supported | Support | Support | Not supported |
CacheControl | Support | Not supported | Support | Not supported | Not supported | Support |
Composer# | Support | Not supported | Support | Not supported | Not supported | Support |
ContentDisposition | Support | Not supported | Support | Not supported | Not supported | Support |
ContentEncoding | Support | Not supported | Support | Not supported | Not supported | Support |
ContentLanguage | Support | Not supported | Supported | Not supported | Not supported | Support |
ContentType | Supported | Not supported | Support | Not supported | Not supported | Support |
CreateTime | Supported | Not supported | Not supported | Not supported | Not supported | Support |
CroppingSuggestions.AspectRatio | Support | Not supported | Support | Support | Support | Not supported |
CroppingSuggestions.Confidence | Support | Not supported | Not supported | Supported | Support | Not supported |
CustomId | Supported | Not supported | Support | Not supported | Not supported | Support |
CustomLabels.* | Support | Not supported | Support | Not supported | Support | Not supported |
DocumentContent | Not supported | Support | Not supported | Not supported | Not supported | Not supported |
DocumentText | Support | Support | Not supported | Not supported | Support | Support |
Duration | Support | Not supported | Not supported | Not supported | Not supported | Support |
ETag | Support | Not supported | Support | Not supported | Not supported | Supported |
Figures.Age | Support | Not supported | Not supported | Support | Support | Not supported |
Figures.AgeSD | Supported | Not supported | Not supported | Support | Support | Not supported |
Figures.Emotion | Supported | Not supported | Supported | Support | Supported | Not supported |
Figures.EmotionConfidence | Supported | Not supported | Not supported | Support | Support | Not supported |
Figures.FaceQuality | Support | Not supported | Not supported | Supported | Support | Not supported |
Figures.FigureClusterId | Supported | Not supported | Supported | Supported | Supported | Not supported |
Figures.FigureConfidence | Support | Not supported | Not supported | Support | Support | Not supported |
Figures.FigureId | Supported | Not supported | Support | Support | Support | Not supported |
Figures.FigureType | Support | Not supported | Support | Supported | Support | Not supported |
Figures.Gender | Support | Not supported | Support | Support | Support | Not supported |
Figures.GenderConfidence | Supported | Not supported | Not supported | Support | Support | Not supported |
FileAccessTime | Support | Not supported | Not supported | Not supported | Not supported | Support |
FileHash | Support | Not supported | Supported | Not supported | Not supported | Supported |
FileModifiedTime | Support | Not supported | Not supported | Not supported | Not supported | Support |
Filename | Support | Support | Support | Not supported | Not supported | Support |
ImageHeight | Supported | Not supported | Not supported | Not supported | Not supported | Support |
ImageWidth | Support | Not supported | Not supported | Not supported | Not supported | Support |
Labels.CentricScore | Support | Not supported | Not supported | Supported | Support | Not supported |
Labels.LabelConfidence | Support | Not supported | Not supported | Support | Supported | Not supported |
Labels.LabelLevel | Supported | Not supported | Not supported | Support | Support | Not supported |
Labels.LabelName | Support | Not supported | Support | Support | Support | Not supported |
Labels.Language | Support | Not supported | Support | Support | Supported | Not supported |
Labels.ParentLabelName | Supported | Not supported | Support | Support | Support | Not supported |
LatLong | Support | Not supported | Not supported | Not supported | Not supported | Not supported |
MediaType | Support | Not supported | Support | Not supported | Not supported | Support |
ObjectACL | Supported | Not supported | Support | Not supported | Not supported | Support |
ObjectId | Supported | Not supported | Support | Not supported | Not supported | Support |
ObjectStatus | Supported | Not supported | Support | Not supported | Not supported | Support |
OCRContents.Contents | Not supported | Support | Not supported | Supported | Support | Not supported |
OCRContents.Language | Support | Not supported | Supported | Support | Support | Not supported |
OSSCRC64 | Supported | Not supported | Support | Not supported | Not supported | Supported |
OSSDeleteMarker | Supported | Not supported | Support | Not supported | Not supported | Support |
OSSExpiration | Support | Not supported | Not supported | Not supported | Not supported | Support |
OSSObjectType | Support | Not supported | Supported | Not supported | Not supported | Support |
OSSStorageClass | Support | Not supported | Supported | Not supported | Not supported | Support |
OSSTagging.* | Support | Not supported | Supported | Not supported | Support | Not supported |
OSSTaggingCount | Supported | Not supported | Not supported | Not supported | Not supported | Support |
OSSURI | Support | Not supported | Supported | Not supported | Not supported | Support |
OSSUserMeta.* | Support | Not supported | Support | Not supported | Support | Not supported |
OSSVersionId | Support | Not supported | Support | Not supported | Not supported | Support |
PageCount | Supported | Not supported | Not supported | Not supported | Not supported | Supported |
Performer | Supported | Not supported | Support | Not supported | Not supported | Supported |
ProduceTime | Supported | Not supported | Not supported | Not supported | Not supported | Support |
ServerSideDataEncryption | Support | Not supported | Support | Not supported | Not supported | Support |
ServerSideEncryption | Support | Not supported | Support | Not supported | Not supported | Support |
ServerSideEncryptionCustomerAlgorithm | Support | Not supported | Support | Not supported | Not supported | Support |
ServerSideEncryptionKeyId | Supported | Not supported | Support | Not supported | Not supported | Support |
Size | Support | Not supported | Not supported | Not supported | Not supported | Supported |
Subtitles.CodecName | Supported | Not supported | Support | Support | Support | Not supported |
Subtitles.Content | Not supported | Supported | Not supported | Support | Support | Not supported |
Subtitles.Language | Support | Not supported | Support | Support | Support | Not supported |
Title | Support | Help and support | Support | Not supported | Not supported | Support |
UpdateTime | Supported | Not supported | Not supported | Not supported | Not supported | Supported |
URI | Supported | Not supported | Support | Not supported | Not supported | Support |
VideoHeight | Support | Not supported | Not supported | Not supported | Not supported | Support |
VideoScore | Support | Not supported | Not supported | Not supported | Not supported | Support |
VideoStreams.CodecName | Support | Not supported | Support | Supported | Support | Not supported |
VideoStreams.Language | Support | Not supported | Support | Support | Technical support | Not supported |
VideoWidth | Supported | Not supported | Not supported | Not supported | Not supported | Supported |
Aggregation
Field | Operator | Sorting support | |
min, max, average, and sum | count, distinct, and group | ||
AccessControlAllowOrigin | Not supported | Support | Support |
AccessControlRequestMethod | Not supported | Support | Support |
Addresses.AddressLine | Not supported | Not supported | Not supported |
Addresses.City | Not supported | Not supported | Not supported |
Addresses.Country | Not supported | Not supported | Not supported |
Addresses.District | Not supported | Not supported | Not supported |
Addresses.Language | Not supported | Not supported | Not supported |
Addresses.Province | Not supported | Not supported | Not supported |
Addresses.Township | Not supported | Not supported | Not supported |
Album | Not supported | Support | Help and support |
AlbumArtist | Not supported | Support | Support |
Artist# | Not supported | Support | Support |
AudioStreams.CodecName | Not supported | Not supported | Not supported |
AudioStreams.Language | Not supported | Not supported | Not supported |
AudioStreams.Lyric | Not supported | Not supported | Not supported |
Bitrate | Support | Support | Supported |
Bodies.Confidence | Not supported | Not supported | Not supported |
CacheControl | Not supported | Support | Support |
Composer# | Not supported | Support | Supported |
ContentDisposition | Not supported | Support | Support |
ContentEncoding | Not supported | Support | Support |
ContentLanguage | Not supported | Support | Support |
ContentType | Not supported | Support | Support |
CreateTime | Not supported | Support | Support |
CroppingSuggestions.AspectRatio | Not supported | Not supported | Not supported |
CroppingSuggestions.Confidence | Not supported | Not supported | Not supported |
CustomId | Not supported | Support | Support |
CustomLabels.* | Not supported | Not supported | Not supported |
DocumentContent | Not supported | Support | Not supported |
Duration | Support | Supported | Supported |
ETag | Not supported | Support | Supported |
Figures.Age | Not supported | Not supported | Not supported |
Figures.AgeSD | Not supported | Not supported | Not supported |
Figures.Emotion | Not supported | Not supported | Not supported |
Figures.EmotionConfidence | Not supported | Not supported | Not supported |
Figures.FaceQuality | Not supported | Not supported | Not supported |
Figures.FigureClusterId | Not supported | Not supported | Not supported |
Figures.FigureConfidence | Not supported | Not supported | Not supported |
Figures.FigureId | Not supported | Not supported | Not supported |
Figures.FigureType | Not supported | Not supported | Not supported |
Figures.Gender | Not supported | Not supported | Not supported |
Figures.GenderConfidence | Not supported | Not supported | Not supported |
FileAccessTime | Not supported | Supported | Support |
FileHash | Not supported | Support | Supported |
FileModifiedTime | Not supported | Support | Help and support |
Filename | Not supported | Support | Supported |
ImageHeight | Support | Support | Support |
ImageWidth | Support | Support | Support |
Labels.CentricScore | Not supported | Not supported | Not supported |
Labels.LabelConfidence | Not supported | Not supported | Not supported |
Labels.LabelLevel | Not supported | Not supported | Not supported |
Labels.LabelName | Not supported | Not supported | Not supported |
Labels.Language | Not supported | Not supported | Not supported |
Labels.ParentLabelName | Not supported | Not supported | Not supported |
Language | Not supported | Support | Support |
LatLong | Not supported | Supported (count and distinct) | Not supported |
MediaType | Not supported | Support | Support |
ObjectACL | Not supported | Support | Support |
ObjectId | Not supported | Support | Support |
OCRContents.Contents | Not supported | Not supported | Not supported |
OCRContents.Language | Not supported | Not supported | Not supported |
OSSCRC64 | Not supported | Support | Supported |
OSSDeleteMarker | Not supported | Supported | Supported |
OSSExpiration | Not supported | Support | Support |
OSSObjectType | Not supported | Support | Support |
OSSStorageClass | Not supported | Support | Support |
OSSTagging.* | Not supported | Not supported | Not supported |
OSSTaggingCount | Support | Support | Support |
OSSURI | Not supported | Support | Supported |
OSSUserMeta.* | Not supported | Not supported | Not supported |
OSSVersionId | Not supported | Support | Support |
PageCount | Supported | Support | Support |
Performer | Not supported | Support | Supported |
ProduceTime | Not supported | Support | Support |
ServerSideDataEncryption | Not supported | Support | Support |
ServerSideEncryption | Not supported | Support | Supported |
ServerSideEncryptionCustomerAlgorithm | Not supported | Support | Supported |
ServerSideEncryptionKeyId | Not supported | Support | Support |
Size | Supported | Support | Support |
Subtitles.CodecName | Not supported | Not supported | Not supported |
Subtitles.Content | Not supported | Not supported | Not supported |
Subtitles.Language | Not supported | Not supported | Not supported |
Title | Not supported | Support | Supported |
UpdateTime | Not supported | Support | Support |
URI | Not supported | Supported | Support |
VideoHeight | Support | Support | Support |
VideoScore | Support | Supported | Support |
VideoStreams.CodecName | Not supported | Not supported | Not supported |
VideoStreams.Language | Not supported | Not supported | Not supported |
VideoWidth | Supported | Supported | Supported |