查询元数据索引

最近更新时间:2024-07-04 09:55:31

我的收藏

简介

本文档提供关于查询元数据索引的相关 API 概览以及 SDK 示例代码。
API
操作描述
获取数据集内已完成索引的一个文件的元数据。

查询元数据索引

功能说明

获取数据集内已完成索引的一个文件的元数据。

示例代码

<?php

require dirname(__FILE__, 2) . '/vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
array(
'region' => $region,
'scheme' => 'https', // 审核时必须为https
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));
try {
//获取数据集内已完成索引的一个文件的元数据。
$result = $cosClient->DescribeFileMetaIndex(array(
'AppId' => 'AppId', // 其中 APPID 获取参考 https://console.cloud.tencent.com/developer
'Headers' => array(
'Accept' => 'application/json',
'Content-Type' => 'application/json',
),
'datasetname' => '', // 数据集名称,同一个账户下唯一。
'uri' => '', // 资源标识字段,表示需要建立索引的文件地址,当前仅支持COS上的文件,字段规则:cos://<BucketName>/<ObjectKey>,其中BucketName表示COS存储桶名称,ObjectKey表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg。 注意: 1、仅支持本账号内的COS文件 2、不支持HTTP开头的地址 3、需UrlEncode

));
// 请求成功
print_r($result);
} catch (\\Exception $e) {
// 请求失败
echo($e);
}

参数说明

参数名称
参数描述
类型
是否必填
datasetname
数据集名称,同一个账户下唯一。
string
uri
资源标识字段,表示需要建立索引的文件地址,当前仅支持 COS 上的文件,字段规则:cos://<BucketName>/<ObjectKey>,其中 BucketName 表示 COS 存储桶名称,ObjectKey 表示文件完整路径,例如:cos://examplebucket-1250000000/test1/img.jpg
注意:
仅支持本账号内的 COS 文件
不支持 HTTP 开头的地址
需 UrlEncode
string

返回参数说明

调用 DescribeFileMetaIndex 函数,会把 API 里面的 xml 返回转换成 json,具体返回参数请参见 查询元数据索引 接口。