一、功能描述
获取数据集内已完成索引的一个文件的元数据。
二、使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
三、请求示例
GET /filemeta?datasetname=test&uri=cos%3A%2F%2Fexamplebucket-1250000000%2Ftest.jpg HTTP/1.1Host: <AppId>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: Auth StringAccept: application/json
注意:说明:
四、请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
五、请求参数
| 参数名称 | 描述 | 类型 | 是否必选 |
| datasetname | 数据集名称,同一个账户下唯一。可通过 控制台 或 接口 查询 | String | 是 |
| uri | 资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则:cos://<BucketName>/<ObjectKey>,其中BucketName表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。注意:仅支持本账号内的 COS 文件不支持 HTTP 开头的地址需 UrlEncode | String | 是 |
六、请求体
该请求无请求体。
七、响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
八、响应体
{ "Files": [{ "COSCRC64": "1111122467985959934", "COSStorageClass": "STANDARD", "ContentType": "image/jpeg", "CreateTime": "2023-12-26T11:43:18.92077679+08:00", "CustomId": "001", "CustomLabels": { "age": "18", "level": "18" }, "DatasetName": "test", "ETag": "\\"21aeb337eb76df70dcb1e2618598****\\"", "FileModifiedTime": "2023-06-07T07:18:04Z", "Filename": "examplebucket-1250000000/test.jpg", "MediaType": "image", "ObjectACL": "default", "Size": "10000", "URI": "cos://examplebucket-1250000000/test.jpg", "UpdateTime": "2023-12-26T11:45:02.445509346+08:00" }], "RequestId": "NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****"}
响应包体具体数据内容如下:
| 参数名称 | 类型 | 描述 |
| Files | Container Array | 文件元数据的结构体。实际返回的数据可能并不包含该结构体的所有属性,这和你索引该文件时选用的工作流模板配置以及文件本身的内容有关。 |
| RequestId | String | 请求 ID。 |
Files 节点内容:
| 参数名称 | 类型 | 描述 |
| COSCRC64 | String | 文件 CRC64值。 |
| COSStorageClass | String | 文件存储空间类型。 |
| ContentType | String | 文件内容类型(MIME Type)。 |
| CreateTime | String | 元数据创建时间的时间戳,格式为 RFC3339Nano。 |
| CustomId | String | 该文件的自定义 ID。该文件索引到数据集后,作为该行元数据的属性存储,用于和你的业务系统进行关联、对应。你可以根据业务需求传入该值,例如将某个 URI 关联到你系统内的某个 ID。推荐传入全局唯一的值。 |
| CustomLabels | Container | 文件自定义标签列表。储存你业务自定义的键名、键值对信息,用于在查询时可以据此为筛选项进行检索。 |
| DatasetName | String | 数据集名称。 |
| ETag | String | Object 生成时会创建相应的 ETag ,ETag 用于标识一个 Object 的内容。 |
| FileModifiedTime | String | 文件最近一次修改时间的时间戳, 格式为 RFC3339Nano。 |
| Filename | String | 文件路径。 |
| MediaType | String | 文件媒体类型。 枚举值:image:图片。other:其他。document:文档。archive:压缩包。audio:音频。video:视频。 |
| ObjectACL | String | 对象的访问控制列表。 |
| Size | Int | 文件大小,单位为字节。 |
| URI | String | 资源标识字段,表示需要建立索引的文件地址。 |
| UpdateTime | String | 元数据修改时间的时间戳,格式为 RFC3339Nano。创建元数据后,如果未更新过元数据,则元数据修改时间的时间戳和元数据创建时间的时间戳相同。 |