Calls the PauseDataPipeline operation to pause a specified data pipeline (DataPipeline) rule.
Usage notes
You can pause a rule that is in the Ready (initializing) or Running state.
A rule is automatically paused (Paused) in the following cases: the destination vector index is full, ErrorMode is set to abort and an error occurs, or a non-retryable error occurs.
Request syntax
POST /?dataPipeline&action=pauseDataPipeline&dataPipelineName=my-data-pipeline HTTP/1.1
Host: oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueRequest 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.
Examples
Sample request:
POST /?dataPipeline&action=pauseDataPipeline&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/xmlSDK
For SDK examples of data pipeline (DataPipeline) operations in each language, see Pause a data pipeline (Java SDK V2) and Pause a data pipeline (Go SDK V2).
ossutil command-line tool
For the ossutil command that corresponds to this operation, see Pause 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. |