GetDataPipelineConfiguration - Object Storage Service - Alibaba Cloud Documentation Center

Calls the GetDataPipelineConfiguration operation to obtain the configuration details and running status of a specified data pipeline (DataPipeline) rule.

Usage notes

The Model Studio API key in the response is masked (for example, sk-****) and is not returned in plaintext.

Request syntax

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

Request headers

This operation uses only common request headers. For more information, see Common Request Headers.

Request parameters

Name	Type	Required	Description	Example
DataPipelineName	string	Yes	The rule name. It can be up to 64 characters in length and can contain uppercase and lowercase letters, digits, and special characters (- _).	my-data-pipeline

Response headers

This operation uses only common response headers. For more information, see Common Response Headers.

Response elements

Name	Type	Description	Example
DataPipelineConfiguration	container	The data pipeline rule information. It contains all the configurations submitted at creation (with ApiKey masked).	-
Status	string	The rule status. Valid values: Ready (ready to start), Running (running; always Running for incremental processing when there is no failure), Failed (terminated due to an exception or failure), Paused (paused, either manually or automatically when the index is full), and Succeeded (completed).	Running
Phase	string	The running phase. Valid values: FullScanning (processing existing data), IncrementalScanning (processing incremental data), and Deleting (deleting).	IncrementalScanning
CreateTime	string	The creation time, in the RFC3339Nano format.	2021-06-29T14:50:13.011643661+08:00

Examples

Sample request:

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=********

Sample response:

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>Use a Model Studio multimodal model to vectorize business data</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

For SDK examples of data pipeline (DataPipeline) operations in each language, see Get a data pipeline (Java SDK V2) and Get a data pipeline (Go SDK V2).

ossutil command-line tool

For the ossutil command that corresponds to this operation, see Get a data pipeline.

Error codes

Error code	HTTP status code	Description
AccessDenied	403	No user authentication information is provided in the request, or you do not have the permissions to perform the operation.
NoSuchDataPipeline	404	The specified DataPipeline does not exist.