简介
查询元数据索引功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于查询元数据索引的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.7.1。
API | 操作描述 |
获取数据集内已完成索引的一个文件的元数据。 |
查询元数据索引
功能说明
获取数据集内已完成索引的一个文件的元数据。
使用示例
function describeFileMetaIndex() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息AppId: '1250000000', // AppId,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = 'filemeta'; // 固定值const host = `${config.AppId}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Query: {// 自定义数据集名称,同一个账户下唯一。;是否必传:是datasetname: 'test-dataset-imagesearch2',// 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos://<BucketName>/<ObjectKey>
,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址 3、需UrlEncode;是否必传:是uri: 'cos://examplebucket-1250000000/exampleImage',},Headers: {// 设置响应体为json,固定值,必须Accept: 'application/json',},},function (err, data) {if (err) {// 处理请求失败console.log(err.message);} else {// 处理请求成功console.log(data);}});}describeFileMetaIndex()
参数说明
os.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Key | 固定值:filemeta | String | 是 |
Url | 请求 url,固定值 | String | 是 |
datasetname | 数据集名称,同一个账户下唯一。 | String | 是 |
uri | 资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则: cos://<BucketName>/<ObjectKey> ,其中 BucketName 表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 仅支持本账号内的 COS 文件 不支持 HTTP 开头的地址 需 UrlEncode | String | 是 |
Accept | 设置响应体为 json,固定值 | String | 是 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
- Files | Array | |
- RequestId | 请求 ID | String |
相关链接