Skip to main content

Drop Pipeline

Drop a specific pipeline


DELETE
https://controller.api.{cloud-region}.zillizcloud.com/v1/pipelines/{PIPELINE_ID}

Example

Notes
  • This API requires an API Key as the authentication token.

Currently, data of the JSON and Array types are not supported in RESTful API requests..

curl --request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${API_KEY}" \
--url "https://controller.api.{CLOUD_REGION}.zillizcloud.com/v1/pipelines/pipe-**********************"

Possible response

{
"code": 200,
"data": {
"pipelineId": "pipe-**********************",
"name": "my_doc_ingestion_pipeline",
"type": "INGESTION",
"description": "A pipeline that splits a text file into chunks and generates embeddings. It also stores the publish_year with each chunk.",
"status": "SERVING",
"functions": [
{
"action": "INDEX_DOC",
"name": "index_my_doc",
"inputField": "doc_url",
"language": "ENGLISH"
},
{
"action": "PRESERVE",
"name": "keep_doc_info",
"inputField": "publish_year",
"outputField": "publish_year",
"fieldType": "Int16"
}
],
"clusterId": "in03-***************",
"newCollectionName": "my_new_collection"
}
}

Request

Parameters

  • No query parameters required

  • Path parameters

    ParameterDescription
    PIPELINE_IDstring(required)

Request Body

No request body required

Response

Returns information of a specific pipeline just dropped.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": {
"pipelineId": "integer",
"name": "string",
"type": "string",
"description": "string",
"status": "string",
"totalTokenUsage": "integer",
"clusterID": "string",
"collectionName": "string"
}
}
  • Response body if we failed to process your request
{
"code": integer,
"message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
dataobject
data.pipelineIdinteger
A pipeline ID.
data.namestring
Name of the pipeline.
data.typestring
Type of the pipeline. For an ingestion pipeline, the value should be INGESTION.
data.descriptionstring
Description of the pipeline.
data.statusstring
Current status of the pipeline. If the value is other than SERVING, the pipeline is not working.
data.totalTokenUsageinteger
Number of consumed tokens in this operation.
functionsobject
data.clusterIDstring
The target cluster to which the pipeline applies.
data.collectionNamestring
The target collection to which the pipeline applies.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
10041(Possible pipeline errors are all under this error code.)