GetDataPipelineConfiguration - 对象存储 OSS

调用GetDataPipelineConfiguration接口获取指定数据管道（DataPipeline）规则的配置详情及运行状态。

注意事项

返回结果中的百炼 API Key 会进行脱敏处理（例如 sk-****），不会明文返回。

请求语法

POST /?dataPipeline&action=getDataPipelineConfiguration&dataPipelineName=my-data-pipeline HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

请求头

此接口仅涉及公共请求头。更多信息，请参见公共请求头（Common Request Headers）。

请求参数

名称	类型	是否必选	描述	示例值
DataPipelineName	string	是	规则名称。最多 64 个字符，支持大小写英文、数字、特殊字符（- _）。	my-data-pipeline

响应头

此接口仅涉及公共响应头。更多信息，请参见公共响应头（Common Response Headers）。

响应元素

名称	类型	描述	示例值
DataPipelineConfiguration	容器	数据管道规则信息。包含创建时提交的全部配置（ApiKey 脱敏）。	-
Status	string	规则状态。取值：Ready（准备就绪待启动）、Running（运行中，增量非失败时恒为 Running）、Failed（异常/失败后终止）、Paused（已暂停，主动暂停或索引写满自动暂停）、Succeeded（已完成）。	Running
Phase	string	运行阶段。取值：FullScanning（存量处理中）、IncrementalScanning（增量处理中）、Deleting（删除中）。	IncrementalScanning
CreateTime	string	创建时间，格式为 RFC3339Nano。	2021-06-29T14:50:13.011643661+08:00

示例

请求示例：

POST /?dataPipeline&action=getDataPipelineConfiguration&dataPipelineName=my-data-pipeline HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Date: Thu, 11 Dec 2025 13:08:38 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********/20251211/cn-hangzhou/oss/aliyun_v4_request,Signature=********

返回示例：

HTTP/1.1 200 OK
x-oss-request-id: E71AFFDC-25BA-5C4C-AA5D-311029******
Date: Thu, 11 Dec 2025 13:08:38 GMT
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DataPipelineConfiguration>
  <DataPipelineName>my-data-pipeline</DataPipelineName>
  <DataPipelineDescription>使用百炼多模态模型为业务数据向量化</DataPipelineDescription>
  <DataPipelineRole>acs:ram::<AccountId>:role/my-data-pipeline-role</DataPipelineRole>
  <Status>Running</Status>
  <Phase>IncrementalScanning</Phase>
  <Sources>
      <InputBucket>my-bucket</InputBucket>
      <InputDataScope>All</InputDataScope>
      <IgnoreDelete>true</IgnoreDelete>
      <FilterConfiguration>
          <PrefixSet>prefix1/</PrefixSet>
          <ObjectMediaTypes>text</ObjectMediaTypes>
          <ObjectMediaTypes>image</ObjectMediaTypes>
      </FilterConfiguration>
  </Sources>
  <DataPipelineEmbeddingConfiguration>
      <EmbeddingProvider>bailian</EmbeddingProvider>
      <ApiKey>sk-****</ApiKey>
      <Model>qwen2.5-vl-embedding</Model>
      <FPS>1</FPS>
  </DataPipelineEmbeddingConfiguration>
  <Destination>
      <VectorBucketName>my-vector-bucket</VectorBucketName>
      <VectorIndexNames>my-index</VectorIndexNames>
      <VectorKeyPrefix></VectorKeyPrefix>
      <ObjectTagToMetadata>key1</ObjectTagToMetadata>
      <UsermetaToMetadata>x-oss-meta-key1</UsermetaToMetadata>
  </Destination>
  <DataPipelineError>
      <ErrorMode>ignoreAndRecord</ErrorMode>
      <ErrorBucket>my-error-bucket</ErrorBucket>
      <ErrorPrefix>error-output/</ErrorPrefix>
  </DataPipelineError>
  <CreateTime>2021-06-29T14:50:13.011643661+08:00</CreateTime>
</DataPipelineConfiguration>

SDK

数据管道（DataPipeline）操作的各语言 SDK 示例，请参见获取数据管道（Java SDK V2）、获取数据管道（Go SDK V2）相关文档。

命令行工具ossutil

本接口对应的 ossutil 命令，请参见获取数据管道。

错误码

错误码	HTTP状态码	描述
AccessDenied	403	发起请求时未传入用户验证信息，或没有操作权限。
NoSuchDataPipeline	404	指定的 DataPipeline 不存在。