Operasi GetDataPipelineConfiguration digunakan untuk memperoleh detail konfigurasi dan status berjalan dari aturan DataPipeline tertentu.
Catatan penggunaan
Kunci API Model Studio dalam respons disembunyikan (misalnya, sk-****) dan tidak dikembalikan dalam bentuk teks biasa.
Sintaksis permintaan
POST /?dataPipeline&action=getDataPipelineConfiguration&dataPipelineName=my-data-pipeline HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueHeader permintaan
Operasi ini hanya menggunakan header permintaan umum. Untuk informasi selengkapnya, lihat Common Request Headers.
Parameter permintaan
Name | Type | Required | Description | Example |
DataPipelineName | string | Yes | Nama aturan. Panjangnya maksimal 64 karakter dan dapat berisi huruf besar dan kecil, angka, serta karakter khusus (- _). | my-data-pipeline |
Header respons
Operasi ini hanya menggunakan header respons umum. Untuk informasi selengkapnya, lihat Common Response Headers.
Elemen respons
Name | Type | Description | Example |
DataPipelineConfiguration | container | Informasi aturan data pipeline. Berisi semua konfigurasi yang dikirim saat pembuatan (dengan ApiKey yang disembunyikan). | - |
Status | string | Status aturan. Nilai yang valid: Ready (siap dijalankan), Running (berjalan; selalu Running untuk pemrosesan inkremental jika tidak terjadi kegagalan), Failed (dihentikan karena pengecualian atau kegagalan), Paused (dijeda, baik secara manual maupun otomatis saat indeks penuh), dan Succeeded (selesai). | Running |
Phase | string | Fase berjalan. Nilai yang valid: FullScanning (memproses data yang sudah ada), IncrementalScanning (memproses data inkremental), dan Deleting (menghapus). | IncrementalScanning |
CreateTime | string | Waktu pembuatan, dalam format RFC3339Nano. | 2021-06-29T14:50:13.011643661+08:00 |
Contoh
Permintaan contoh:
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=********Respons contoh:
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
Untuk contoh SDK operasi DataPipeline dalam berbagai bahasa, lihat Get a data pipeline (Java SDK V2) dan Get a data pipeline (Go SDK V2).
Alat baris perintah ossutil
Untuk perintah ossutil yang sesuai dengan operasi ini, lihat Get a data pipeline.
Kode error
Error code | HTTP status code | Description |
AccessDenied | 403 | Tidak ada informasi autentikasi pengguna yang disediakan dalam permintaan, atau Anda tidak memiliki izin untuk melakukan operasi tersebut. |
NoSuchDataPipeline | 404 | DataPipeline yang ditentukan tidak ada. |