Items - Get Data Pipeline Definition

Служба:: DataPipeline

Версия API:: v1

Возвращает указанное общедоступное определение конвейера данных.
Этот API поддерживает длительные операции (LRO).

При получении общедоступного определения DataPipeline метка конфиденциальности не является частью определения.

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для конвейера данных.

Обязательные делегированные области

DataPipeline.ReadWrite.All или Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition

С использованием необязательных параметров:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition?format={format}

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataPipelineId	path	True	string (uuid)	Идентификатор конвейера данных.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
format	query		string	Формат общедоступного определения конвейера данных.

Ответы

Имя	Тип	Описание
200 OK	DataPipelineDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a data pipeline public definition example

Образец запроса

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/dataPipelines/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Пример ответа

Код состояния:: 200

{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Код состояния:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Определения

Имя	Описание
DataPipelineDefinition	Объект общедоступного определения конвейера данных. Дополнительные сведения о структуре определения конвейера данных см. в этой статье .
DataPipelineDefinitionPart	Объект части определения конвейера данных.
DataPipelineDefinitionResponse	Ответ общедоступного определения конвейера данных.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

DataPipelineDefinition

Объект

Объект общедоступного определения конвейера данных. Дополнительные сведения о структуре определения конвейера данных см. в этой статье .

Имя	Тип	Описание
format	string	Формат определения конвейера данных.
parts	DataPipelineDefinitionPart[]	Список частей определения.

DataPipelineDefinitionPart

Объект

Объект части определения конвейера данных.

Имя	Тип	Описание
path	string	Путь к части конвейера данных.
payload	string	Полезные данные части конвейера данных.
payloadType	PayloadType	Тип полезных данных.

DataPipelineDefinitionResponse

Объект

Ответ общедоступного определения конвейера данных.

Имя	Тип	Описание
definition	DataPipelineDefinition	Объект общедоступного определения конвейера данных. Дополнительные сведения о структуре определения конвейера данных см. в этой статье .

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable	boolean	Если задано значение true, запрос можно получить. `Retry-After` Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.