SimpleQuery_智能媒体管理_API文档-阿里云OpenAPI开发者门户

接口说明

请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
返回结果仅为示例，根据工作流模板配置不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请使用钉钉搜索钉钉群号 88490020073 加入钉钉群进行反馈。

使用限制

每次查询最多返回 100 个文件信息。
每次查询最多返回 2000 条聚合统计信息。
子查询条件最大支持设置 100 个。
子查询嵌套深度最多支持 5 层。

查询条件示例

如果要搜索 JPEG 格式的图片且图片尺寸大于 1000 像素，则 Query 填写示例如下：

{
  "SubQueries":[
    {
      "Field":"ContentType",
      "Value": "image/jpeg",
      "Operation":"eq"
    },         
    {
      "Field":"ImageWidth",
      "Value":"1000",
      "Operation":"gt"
    }
  ],
  "Operation":"and"
}

如果要搜索oss://examplebucket/path/中所有包含电视或音响标签的文件且该文件的大小大于 10 MB，则 Query 填写示例如下：

说明这里电视和音响是同一个文件的不同标签，在Labels字段中以两个独立对象的方式存在，请注意和下一个例子的区别。

{
  "SubQueries": [
    {
      "Field": "URI",
      "Value": "oss://examplebucket/path/",
      "Operation": "prefix"
    },
    {
      "Field": "Size",
      "Value": "1048576",
      "Operation": "gt"
    },
    {
      "SubQueries": [
        {
          "Field": "Labels.LabelName",
          "Value": "电视",
          "Operation": "eq"
        },
        {
          "Field": "Labels.LabelName",
          "Value": "音响",
          "Operation": "eq"
        }
      ],
      "Operation": "or"
    }
  ],
  "Operation": "and"
}

如果要排除人脸信息中有一个 36 岁以上的男性的文件，则 Query 填写示例如下：

说明和上一个例子不同的是，这里要求某一个人脸同时满足 36 岁以上、男性两个条件，这和一张图片中有多个人脸，其中某个是男性，而其中另一个是 36 岁以上这个需求是不同的。在该请求中，需要使用nested查询实现条件在同一个元素内同时满足的限制。

{
	"Operation": "not",
	"SubQueries": [{
		"Operation": "nested",
		"SubQueries": [{
			"Operation": "and",
			"SubQueries": [{
				"Field": "Figures.Age",
				"Operation": "gt",
				"Value": "36"
			}, {
				"Field": "Figures.Gender",
				"Operation": "eq",
				"Value": "male"
			}]
		}]
	}]
}

如果要搜索 JPEG 格式的图片且图片存在自定义标签和系统标签，则 Query 填写示例如下：

{
  "SubQueries":[
    {
      "Field":"ContentType",
      "Value": "image/jpeg",
      "Operation":"eq"
    },         
    {
      "Field":"CustomLabels.test",
      "Operation":"exist"
    },         
    {
      "Field":"Labels.LabelName",
      "Operation":"exist"
    }
  ],
  "Operation":"and"
}

结合以上搜索条件，您还可以通过聚合操作实现不同数据的统计和分析，例如计算符合搜索条件的所有文件的大小总和、数量、平均值或者最值，统计所有符合搜索条件图片的尺寸分布情况。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

imm:SimpleQuery	List	Dataset acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}	无	无

请求参数

字段名称	字段详情
NextTokenstring	当文件总数大于设置的 MaxResults 时，用于翻页的 token。展开详情示例值:MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResultsinteger<int32>	不传 Aggregations 参数查询文件时，表示返回文件的最大个数，取值范围为 0~100。展开详情示例值:10
ProjectNamestring	项目名称，获取方式请参见创建项目。示例值:test-project参考取值来源: UpdateProject CreateProject ListProjects
DatasetNamestring	数据集名称，获取方式请参见创建数据集。示例值:test-dataset参考取值来源: UpdateDataset CreateDataset ListDatasets
QuerySimpleQuery	SimpleQuery 查询参数条件，可自嵌套。
Sortstring	排序字段列表。请参考字段和操作符的支持列表。展开详情示例值:Size,Filename
Orderstring	排序字段的排序方式。取值如下：展开详情示例值:asc,desc
Aggregationsarray<object>	聚合字段信息列表。展开详情
WithFieldsarray<string>	仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。展开详情
WithoutTotalHitsboolean	是否返回命中记录总数展开详情

返回参数

字段名称	字段详情
NextTokenstring	当文件总数大于设置的 MaxResults 时，用于翻页的 token。展开详情示例值:MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
RequestIdstring	请求 ID。示例值:2C5C1E0F-D8B8-4DA0-8127-EC32C771****
Filesarray<File>	文件信息列表。仅在请求的 Aggregations 为空时返回。
Aggregationsarray<object>	聚合字段信息列表。仅在请求的 Aggregations 不为空时返回。
TotalHitsinteger<int64>	命中的记录数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:10

返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-11-22	新增请求参数WithoutTotalHits
	2023-09-04	变更返回参数
	2022-01-25	变更返回参数
	2021-06-15	新增OpenAPI，简单查询