GetMetaQueryStatus

更新时间:
复制 MD 格式

调用 GetMetaQueryStatus 接口查询指定 Bucket 的元数据管理状态、检索模式以及开启时所配置的各项参数。

注意事项

  • 阿里云账号默认拥有查询元数据管理状态和配置的权限。如需通过 RAM 用户查询,请确保 RAM 用户拥有 oss:MetaQuery 权限。

  • 当 Bucket 未开启元数据管理,或处于关闭后的清理过程中,接口会返回 MetaQueryNotExist(HTTP 404)。

  • 响应中的 RouteRuleIndexOptionsNotificationAttributesDatasetConfigFiltersWorkflowParameters 字段仅在 OpenMetaQuery时传入了对应配置才会出现。其中 WorkflowParameters 为兼容旧版本的基础工作流开关回显。

请求语法

POST /?metaQuery&action=getMetaQueryStatus HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

请求头

此接口仅涉及公共请求头。更多信息,请参见公共请求头(Common Request Headers)

请求元素

此接口无请求元素。

响应头

此接口仅涉及公共响应头。更多信息,请参见公共响应头(Common Response Headers)

响应元素

名称

类型

是否必选

示例值

描述

MetaQueryStatus

容器

不涉及

元数据管理状态和配置的容器。

子节点:State、Phase、CreateTime、UpdateTime、MetaQueryMode、WorkflowParameters、Filters、NotificationAttributes、DatasetConfig、IndexOptions、RouteRule

State

字符串

Running

元数据管理当前状态。取值如下:

  • Ready:初始化中

  • Running:正常服务

  • Stop:已停止

  • Retrying:异常后重试中

  • Failed:初始化失败

  • Deleted:已关闭或清理中

父节点:MetaQueryStatus

Phase

字符串

IncrementalScanning

当前扫描阶段。取值如下:

  • FullScanning:正在对存量 Object 做全量扫描

  • IncrementalScanning:全量扫描已完成,正在跟踪后续增量事件

父节点:MetaQueryStatus

CreateTime

字符串

2026-05-20T08:00:00.000+08:00

元数据管理首次开启的时间,RFC 3339 格式。

父节点:MetaQueryStatus

UpdateTime

字符串

2026-05-20T08:30:00.000+08:00

上次更新配置的时间,RFC 3339 格式。

父节点:MetaQueryStatus

MetaQueryMode

字符串

semantic

检索模式。取值如下:

  • basic:标量检索

  • semantic:向量检索

父节点:MetaQueryStatus

WorkflowParameters

容器

不涉及

工作流参数容器,回显 OpenMetaQuery 时配置的兼容旧版本 AI 内容感知基础开关。后续新功能推荐使用 DatasetConfig

子节点:WorkflowParameter

父节点:MetaQueryStatus

WorkflowParameter

容器

不涉及

单个工作流参数的容器。

子节点:Name、Value

父节点:WorkflowParameters

Name

字符串

VideoInsightEnable

工作流参数的名称。取值如下:

  • VideoInsightEnable:视频内容感知开关

  • ImageInsightEnable:图片内容感知开关

  • UserDefinedLabelsEnable:用户自定义标签开关

父节点:WorkflowParameter

Value

字符串

True

工作流参数的值。取值如下:

  • True:开启

  • False:关闭

父节点:WorkflowParameter

Filters

容器

不涉及

过滤条件容器,回显 OpenMetaQuery 时配置的过滤规则。

子节点:Filter

父节点:MetaQueryStatus

Filter

字符串

Size > 1024

单个过滤条件表达式。

父节点:Filters

NotificationAttributes

容器

不涉及

消息通知配置容器,回显 OpenMetaQuery 时配置的 MNS 通知。

子节点:Notifications、WithFields

父节点:MetaQueryStatus

Notifications

容器

不涉及

消息通知配置容器。

子节点:Notification

父节点:NotificationAttributes

Notification

容器

不涉及

单个消息通知配置。

子节点:MNS

父节点:Notifications

MNS

字符串

imm-index-notification

MNS 主题名称。

父节点:Notification

WithFields

容器

不涉及

消息通知容器,回显消息通知返回的字段配置。

子节点:WithField

父节点:NotificationAttributes

WithField

字符串

Insights

消息通知返回的字段。取值如下:

  • Insights:AI 分析后对该文件的简短描述

  • Labels:AI 分析后对该文件识别的标签

父节点:WithFields

DatasetConfig

容器

不涉及

Dataset 级配置容器,回显 OpenMetaQuery 时配置的内容感知细项与 Dataset 维度的智能分组。详细字段见 DatasetConfig 数据结构

父节点:MetaQueryStatus

IndexOptions

容器

不涉及

索引选项容器,回显 OpenMetaQuery 时配置的索引行为。

子节点:IgnoreObjectDelete、IgnoreEvents

父节点:MetaQueryStatus

IgnoreObjectDelete

字符串

True

取值如下:

  • True:Object 删除后其元数据不会自动从索引中移除

  • False:Object 删除时同步移除元数据

父节点:IndexOptions

IgnoreEvents

容器

不涉及

要忽略的 OSS 事件类型列表。

子节点:IgnoreEvent

父节点:IndexOptions

IgnoreEvent

字符串

ObjectRemoved:*

要忽略的 OSS 事件类型。

父节点:IgnoreEvents

RouteRule

容器

不涉及

路由规则容器,回显 OpenMetaQuery 时配置的多 Dataset 路由规则。

子节点:Type、AutoCreateDataset、OSSTagKey

父节点:MetaQueryStatus

Type

字符串

OSSTag

路由类型。取值如下:

  • default:不做按规则路由

  • OSSTag:按 Object 上指定 Tag 的 Value 路由到同名 Dataset

父节点:RouteRule

AutoCreateDataset

字符串

True

当 OSS Tag 命中的 Dataset 不存在时,是否自动创建。取值 True / False。

父节点:RouteRule

OSSTagKey

字符串

routing-dataset

路由所依据的 OSS Object Tag 的 Key。

父节点:RouteRule

示例

请求示例

POST /?metaQuery&action=getMetaQueryStatus HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Wed, 20 May 2026 08:30:00 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20260520/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

返回示例

basic 模式:

HTTP/1.1 200 OK
x-oss-request-id: 64C8B6F4E7C5A3A8B9D6E7F1
Date: Wed, 20 May 2026 08:30:01 GMT
Content-Type: application/xml
Server: AliyunOSS

<?xml version="1.0" encoding="UTF-8"?>
<MetaQueryStatus>
  <State>Running</State>
  <Phase>IncrementalScanning</Phase>
  <CreateTime>2026-05-20T08:00:00.000+08:00</CreateTime>
  <UpdateTime>2026-05-20T08:10:00.000+08:00</UpdateTime>
  <MetaQueryMode>basic</MetaQueryMode>
</MetaQueryStatus>

semantic 模式,含 RouteRule、IndexOptions、NotificationAttributes、DatasetConfig:

HTTP/1.1 200 OK
x-oss-request-id: 64C8B6F4E7C5A3A8B9D6E7F3
Date: Wed, 20 May 2026 08:30:01 GMT
Content-Type: application/xml
Server: AliyunOSS

<?xml version="1.0" encoding="UTF-8"?>
<MetaQueryStatus>
  <State>Running</State>
  <Phase>IncrementalScanning</Phase>
  <CreateTime>2026-05-20T08:00:00.000+08:00</CreateTime>
  <UpdateTime>2026-05-20T08:30:00.000+08:00</UpdateTime>
  <MetaQueryMode>semantic</MetaQueryMode>
  <Filters>
    <Filter>Size > 1024</Filter>
    <Filter>Filename prefix (cGhvdG9zLw==)</Filter>
  </Filters>
  <IndexOptions>
    <IgnoreObjectDelete>True</IgnoreObjectDelete>
  </IndexOptions>
  <RouteRule>
    <Type>OSSTag</Type>
    <AutoCreateDataset>True</AutoCreateDataset>
    <OSSTagKey>routing-dataset</OSSTagKey>
  </RouteRule>
  <NotificationAttributes>
    <Notifications>
      <Notification>
        <MNS>imm-index-notification</MNS>
      </Notification>
    </Notifications>
    <WithFields>
      <WithField>Insights</WithField>
      <WithField>Labels</WithField>
    </WithFields>
  </NotificationAttributes>
  <DatasetConfig>
    <Insights>
      <Language>en</Language>
      <Image>
        <Caption>
          <Enable>True</Enable>
        </Caption>
      </Image>
      <Video>
        <Caption>
          <Enable>True</Enable>
        </Caption>
      </Video>
    </Insights>
  </DatasetConfig>
</MetaQueryStatus>