GetDataPipelineConfiguration - Object Storage Service

調用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 不存在。