如果您希望从Bucket存储的海量Object中快速查找与指定的Object名称、ETag、存储类型、大小、最后修改时间等条件匹配的Object，您可以使用数据索引功能。通过数据索引功能，您可以在查找目标Object时指定过滤条件，对查询结果按需选择排序和聚合的方式，提升查找目标Object的效率。
注意事项
本文示例代码以华东1（杭州）的地域ID
cn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
示例代码
开启元数据查询功能
以下代码用于为指定Bucket开启元数据查询功能。开启后，OSS会为Bucket创建元数据索引库并为Bucket中的所有Object建立元数据索引。元数据索引库创建完成后，OSS会继续对Bucket中新增文件进行准实时的增量追踪扫描并为增量文件建立元数据索引。
<?php
// 引入自动加载文件，确保依赖库能够正确加载
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// 定义命令行参数的描述信息
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地域（必填）
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 访问域名（可选）
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名称（必填）
];
// 将参数描述转换为getopt所需的长选项格式
// 每个参数后面加上":"表示该参数需要值
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 验证必填参数是否存在
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 获取参数的帮助信息
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 如果必填参数缺失，则退出程序
}
}
// 从解析的参数中提取值
$region = $options["region"]; // Bucket所在的地域
$bucket = $options["bucket"]; // Bucket名称
// 加载环境变量中的凭证信息
// 使用EnvironmentVariableCredentialsProvider从环境变量中读取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 设置凭证提供者
$cfg->setRegion($region); // 设置Bucket所在的地域
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // 如果提供了访问域名，则设置endpoint
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 创建OpenMetaQueryRequest对象，用于开启Bucket的元数据查询功能
$request = new Oss\Models\OpenMetaQueryRequest(
bucket: $bucket
);
// 执行开启元数据查询功能的操作
$result = $client->openMetaQuery($request);
// 打印开启元数据查询功能的结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP状态码，例如200表示成功
'request id:' . $result->requestId . PHP_EOL // 请求ID，用于调试或追踪请求
);
获取元数据索引库信息
以下代码用于获取指定Bucket的元数据索引库信息。
<?php
// 引入自动加载文件，确保依赖库能够正确加载
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// 定义命令行参数的描述信息
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地域（必填）
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 访问域名（可选）
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名称（必填）
];
// 将参数描述转换为getopt所需的长选项格式
// 每个参数后面加上":"表示该参数需要值
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 验证必填参数是否存在
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 获取参数的帮助信息
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 如果必填参数缺失，则退出程序
}
}
// 从解析的参数中提取值
$region = $options["region"]; // Bucket所在的地域
$bucket = $options["bucket"]; // Bucket名称
// 加载环境变量中的凭证信息
// 使用EnvironmentVariableCredentialsProvider从环境变量中读取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 设置凭证提供者
$cfg->setRegion($region); // 设置Bucket所在的地域
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // 如果提供了访问域名，则设置endpoint
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 创建GetMetaQueryStatusRequest对象，用于获取Bucket的元数据查询状态
$request = new Oss\Models\GetMetaQueryStatusRequest(
bucket: $bucket
);
// 执行获取元数据查询状态的操作
$result = $client->getMetaQueryStatus($request);
// 打印获取元数据查询状态的结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP状态码，例如200表示成功
'request id:' . $result->requestId . PHP_EOL . // 请求ID，用于调试或追踪请求
'meta query status:' . var_export($result->metaQueryStatus, true) . PHP_EOL // 元数据查询功能的状态（如开启、关闭等）
);
查询满足指定条件的Object
以下代码通过标量检索功能查询满足指定条件Object，并按照指定字段和排序方式列出Object信息。
<?php
// 引入自动加载文件，确保依赖库能够正确加载
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// 定义命令行参数的描述信息
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地域（必填）
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 访问域名（可选）
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名称（必填）
];
// 将参数描述转换为getopt所需的长选项格式
// 每个参数后面加上":"表示该参数需要值
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 验证必填参数是否存在
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 获取参数的帮助信息
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 如果必填参数缺失，则退出程序
}
}
// 从解析的参数中提取值
$region = $options["region"]; // Bucket所在的地域
$bucket = $options["bucket"]; // Bucket名称
// 加载环境变量中的凭证信息
// 使用EnvironmentVariableCredentialsProvider从环境变量中读取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 设置凭证提供者
$cfg->setRegion($region); // 设置Bucket所在的地域
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // 如果提供了访问域名，则设置endpoint
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 创建DoMetaQueryRequest对象，用于执行元数据查询操作
$request = new \AlibabaCloud\Oss\V2\Models\DoMetaQueryRequest(
bucket: $bucket,
metaQuery: new \AlibabaCloud\Oss\V2\Models\MetaQuery(
maxResults: 5, // 最大返回结果数量
query: "{'Field': 'Size','Value': '1048576','Operation': 'gt'}", // 查询条件：大小大于1MB的对象
sort: 'Size', // 按照对象大小排序
order: \AlibabaCloud\Oss\V2\Models\MetaQueryOrderType::ASC, // 升序排序
aggregations: new \AlibabaCloud\Oss\V2\Models\MetaQueryAggregations( // 聚合操作
aggregations: [
new \AlibabaCloud\Oss\V2\Models\MetaQueryAggregation(
field: 'Size', // 对象大小字段
operation: 'sum' // 聚合操作：求和
),
new \AlibabaCloud\Oss\V2\Models\MetaQueryAggregation(
field: 'Size', // 对象大小字段
operation: 'max' // 聚合操作：求最大值
),
]
)
)
);
// 执行元数据查询操作
$result = $client->doMetaQuery($request);
// 打印元数据查询的结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP状态码，例如200表示成功
'request id:' . $result->requestId . PHP_EOL . // 请求ID，用于调试或追踪请求
'result:' . var_export($result, true) . PHP_EOL // 查询结果，包含匹配的对象及其聚合数据
);
关闭元数据查询功能
以下代码用于关闭指定Bucket的元数据查询功能。
<?php
// 引入自动加载文件，确保依赖库能够正确加载
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// 定义命令行参数的描述信息
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // Bucket所在的地域（必填）
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 访问域名（可选）
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // Bucket名称（必填）
];
// 将参数描述转换为getopt所需的长选项格式
// 每个参数后面加上":"表示该参数需要值
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// 解析命令行参数
$options = getopt("", $longopts);
// 验证必填参数是否存在
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 获取参数的帮助信息
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 如果必填参数缺失，则退出程序
}
}
// 从解析的参数中提取值
$region = $options["region"]; // Bucket所在的地域
$bucket = $options["bucket"]; // Bucket名称
// 加载环境变量中的凭证信息
// 使用EnvironmentVariableCredentialsProvider从环境变量中读取Access Key ID和Access Key Secret
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// 使用SDK的默认配置
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 设置凭证提供者
$cfg->setRegion($region); // 设置Bucket所在的地域
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // 如果提供了访问域名，则设置endpoint
}
// 创建OSS客户端实例
$client = new Oss\Client($cfg);
// 创建CloseMetaQueryRequest对象，用于关闭Bucket的元数据查询功能
$request = new \AlibabaCloud\Oss\V2\Models\CloseMetaQueryRequest(
bucket: $bucket
);
// 执行关闭元数据查询功能的操作
$result = $client->closeMetaQuery($request);
// 打印关闭元数据查询功能的结果
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP状态码，例如200表示成功
'request id:' . $result->requestId . PHP_EOL // 请求ID，用于调试或追踪请求
);
该文章对您有帮助吗？