简介
查询元数据索引功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于查询元数据索引的相关 API 概览以及 SDK 示例代码。
注意:
API | 操作描述 |
查询元数据索引 |
查询元数据索引
功能说明
获取数据集内已完成索引的一个文件的元数据。
方法原型
public DescribeFileMetaIndexResponse describeFileMetaIndex(DescribeFileMetaIndexRequest customRequest)
请求示例
DescribeFileMetaIndexRequest request = new DescribeFileMetaIndexRequest();request.setAppId("1234567890");//设置数据集名称,同一个账户下唯一。;是否必传:是request.setDatasetname("数据集名称");//设置资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则:cos://<BucketName>/<ObjectKey>,其中BucketName表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 仅支持本账号内的 COS 文件 不支持 HTTP 开头的地址 需 UrlEncode;是否必传:是request.setUri("cos://facesearch-12500000000");DescribeFileMetaIndexResponse response = client.describeFileMetaIndex(request);
参数说明
Request: 中的具体数据描述如下
参数名称 | 描述 | 类型 | 是否必传 |
AppId | String | 是 | |
datasetname | 数据集名称,同一个账户下唯一。 | String | 是 |
uri | 资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则: cos://<BucketName>/<ObjectKey> ,其中BucketName表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg 。 注意: 仅支持本账号内的 COS 文件 不支持 HTTP 开头的地址 需 UrlEncode | String | 是 |
响应参数说明:
DescribeFileMetaIndexResponse 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
requestId | 请求 ID。 | String |
files | 文件元数据的结构体。实际返回的数据可能并不包含该结构体的所有属性,这和您索引该文件时选用的工作流模板配置以及文件本身的内容有关。 | Container Array |
FilesDetail 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
createTime | 元数据创建时间的时间戳,格式为 RFC3339Nano。 | String |
updateTime | 元数据修改时间的时间戳,格式为 RFC3339Nano。 创建元数据后,如果未更新过元数据,则元数据修改时间的时间戳和元数据创建时间的时间戳相同。 | String |
uRI | 资源标识字段,表示需要建立索引的文件地址。 | String |
filename | 文件路径。 | String |
mediaType | 文件媒体类型。 枚举值: image:图片。 other:其他。 document:文档。 archive:压缩包。 audio:音频。 video:视频。 | String |
contentType | 文件内容类型(MIME Type)。 | String |
cOSStorageClass | 文件存储空间类型。 | String |
cOSCRC64 | 文件 CRC64值。 | String |
objectACL | 对象 ACL。 | String |
size | 文件大小,单位为字节。 | Integer |
cacheControl | 指定 Object 被下载时网页的缓存行为。 | String |
eTag | Object 生成时会创建相应的ETag ,ETag 用于标识一个 Object 的内容。 | String |
fileModifiedTime | 文件最近一次修改时间的时间戳, 格式为 RFC3339Nano。 | String |
CustomId | 该文件的自定义 ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和您的业务系统进行关联、对应。您可以根据业务需求传入该值,例如将某个URI关联到您系统内的某个ID。推荐传入全局唯一的值。 | String |
customLabels | 文件自定义标签列表。储存您业务自定义的键名、键值对信息,用于在查询时可以据此为筛选项进行检索。 | HashMap<String, String> |
datasetName | 数据集名称。 | String |
返回结果说明
成功:返回 DescribeFileMetaIndexResponse 对象响应信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。