Поделиться через

Items - Get Spark Job Definition Definition

Служба:
SparkJobDefinition
Версия API:
v1

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

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

Разрешения

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

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

SparkJobDefinition.ReadWrite.All или Item.ReadWrite.All

Ограничения

Этот API заблокирован для определения задания Spark с зашифрованной меткой конфиденциальности.

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

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

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition
С использованием необязательных параметров: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/getDefinition?format={format}

Параметры URI

Имя В Обязательно Тип Описание
sparkJobDefinitionId
 path True

string (uuid)

Идентификатор определения задания Spark.
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.
format
 query

string

Формат общедоступного определения задания Spark.

Ответы

Имя Тип Описание
200 OK

SparkJobDefinitionDefinitionResponse

Запрос успешно завершен.
202 Accepted

Запрос принят. Получение определения выполняется.

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a spark job definition public definition example

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

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

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

Код состояния:
200 
{
  "definition": {
    "parts": [
      {
        "path": "SparkJobDefinitionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "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

Определения

Имя Описание
ErrorRelatedResource

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

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

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

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

Ответ общедоступного определения задания Spark.
SparkJobDefinitionPublicDefinition

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

Объект части определения определения задания Spark.

ErrorRelatedResource

Object

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

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

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

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

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

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

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

PayloadType

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

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

Значение Описание
InlineBase64

Встроенная база 64.

SparkJobDefinitionDefinitionResponse

Object

Ответ общедоступного определения задания Spark.

Имя Тип Описание
definition

SparkJobDefinitionPublicDefinition

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

SparkJobDefinitionPublicDefinition

Object

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

Имя Тип Описание
format

string

Формат определения элемента. Поддерживаемый формат: SparkJobDefinitionV1.
parts

SparkJobDefinitionPublicDefinitionPart[]

Список частей определения.

SparkJobDefinitionPublicDefinitionPart

Object

Объект части определения определения задания Spark.

Имя Тип Описание
path

string

Путь к части определения задания Spark.
payload

string

Полезные данные общедоступного определения задания Spark.
payloadType

PayloadType

Тип полезных данных.