Amazon
Web Services
Microsoft Azure
Google Cloud PlatformAPI de empregos 2.0
Importante
Este artigo documenta a versão 2.0 do Jobs API. No entanto, a Databricks recomenda o uso do Jobs API 2.1 para clientes e scripts novos e existentes. Para obter detalhes sobre as alterações das versões 2.0 e 2.1, consulte Atualização da API do Jobs 2.0 para a 2.1.
O site Jobs API permite que o senhor crie, edite e exclua trabalhos. O tamanho máximo permitido de uma solicitação à API do Jobs é de 10 MB.
Para obter detalhes sobre as atualizações do Jobs API que suportam a solicitação de várias tarefas com o Databricks Job, consulte Atualização do Jobs API 2.0 para 2.1.
Aviso
O senhor nunca deve codificar segredos ou armazená-los em texto simples. Use a API de segredos para gerenciar segredos na CLI do Databricks. Use os utilitários Secrets (dbutils.secrets) para fazer referência a segredos no Notebook e no Job.
Observação
Se o senhor receber um erro de nível 500 ao fazer solicitações de API do Jobs, a Databricks recomenda tentar novamente as solicitações por até 10 minutos (com um intervalo mínimo de 30 segundos entre as tentativas).
Importante
Para acessar as APIs REST da Databricks, o senhor deve se autenticar.
Criar
Endpoint |
Método HTTP |
|---|---|
|
|
Criar um novo trabalho.
Exemplo
Este exemplo cria um trabalho que executa a JAR tarefa às 22h15 todas as noites.
Solicitação
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/create \
--data @create-job.json \
| jq .
create-job.json:
{
"name": "Nightly model training",
"new_cluster": {
"spark_version": "7.3.x-scala2.12",
"node_type_id": "r3.xlarge",
"aws_attributes": {
"availability": "ON_DEMAND"
},
"num_workers": 10
},
"libraries": [
{
"jar": "dbfs:/my-jar.jar"
},
{
"maven": {
"coordinates": "org.jsoup:jsoup:1.7.2"
}
}
],
"email_notifications": {
"on_start": [],
"on_success": [],
"on_failure": []
},
"webhook_notifications": {
"on_start": [
{
"id": "bf2fbd0a-4a05-4300-98a5-303fc8132233"
}
],
"on_success": [
{
"id": "bf2fbd0a-4a05-4300-98a5-303fc8132233"
}
],
"on_failure": []
},
"notification_settings": {
"no_alert_for_skipped_runs": false,
"no_alert_for_canceled_runs": false,
"alert_on_last_attempt": false
},
"timeout_seconds": 3600,
"max_retries": 1,
"schedule": {
"quartz_cron_expression": "0 15 22 * * ?",
"timezone_id": "America/Los_Angeles"
},
"spark_jar_task": {
"main_class_name": "com.databricks.ComputeModels"
}
}
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.O conteúdo de
create-job.jsoncom campos apropriados para suas soluções.
Estrutura da solicitação
Importante
Quando o senhor executa um Job em um novo Job cluster, o Job é tratado como uma carga de trabalho de computação de Jobs (automatizada) sujeita aos preços de computação de Jobs.
Quando o senhor executa um trabalho em um site existente clusters todo-propósito, ele é tratado como uma carga de trabalho de computação para todos os fins (interativa) sujeita aos preços de computação para todos os fins.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se existing_cluster_id, o ID de um cluster existente que será usado para toda a execução desse Job. Ao executar o Job em um cluster existente, talvez seja necessário reiniciar manualmente o cluster se ele parar de responder. Sugerimos que o Job seja executado no novo site clusters para maior confiabilidade. Se for new_cluster, uma descrição de um cluster que será criado para cada execução. Se estiver especificando um PipelineTask, esse campo pode estar vazio. |
|
NotebookTask OU SparkJarTask OU SparkPythonTask OU SparkSubmitTask OU PipelineTask OU RunJobTask |
Se for Notebook, indica que esse trabalho deve ser executado em um Notebook. Esse campo não pode ser especificado em conjunto com spark_jar_task. Se spark_jar_task, indica que esse trabalho deve ser executado em JAR. Se for spark_python_task, indica que esse trabalho deve executar um arquivo Python. Se for spark_submit_task, indica que esse trabalho deve ser iniciado pelo script de envio do spark. Se for pipeline, indica que esse trabalho deve ser executado em Delta Live Tables pipeline. Se for execução, indica que esse trabalho deve executar outro trabalho. |
|
|
Um nome opcional para o trabalho. O valor de default é |
|
Uma matriz da biblioteca |
Uma lista opcional de bibliotecas a serem instaladas no site cluster que executará o trabalho. O valor default é uma lista vazia. |
|
Um conjunto opcional de endereços email notificados quando a execução desse trabalho começa e é concluída e quando esse trabalho é excluído. O comportamento do default é não enviar nenhum e-mail. |
|
|
Um conjunto opcional de destinos do sistema a serem notificados quando a execução desse trabalho começar, for concluída ou falhar. |
|
|
Configurações de notificação opcionais que são usadas ao enviar notificações para cada um dos |
|
|
|
Um tempo limite opcional aplicado a cada execução desse trabalho. O comportamento do default é não ter tempo limite. |
|
|
Um número máximo opcional de vezes para tentar novamente uma execução malsucedida. Uma execução é considerada malsucedida se for concluída com o result_state |
|
|
Um intervalo mínimo opcional em milissegundos entre o início da execução com falha e a execução de nova tentativa subsequente. O comportamento do default é que as execuções malsucedidas são imediatamente repetidas. |
|
|
Uma política opcional para especificar se um trabalho deve ser tentado novamente quando atingir o tempo limite. O comportamento do default é não tentar novamente após o tempo limite. |
|
Um programador periódico opcional para esse trabalho. O comportamento do default é que a execução do trabalho é acionada ao clicar em Executar agora na interface do usuário do Jobs ou ao enviar uma solicitação API para |
|
|
|
Um número máximo opcional permitido de execução concorrente do trabalho. Defina esse valor se o senhor quiser poder executar várias execuções do mesmo trabalho simultaneamente. Isso é útil, por exemplo, se o senhor acionar o seu trabalho em uma programação frequente e quiser permitir que execuções consecutivas se sobreponham umas às outras, ou se quiser acionar várias execuções que diferem em seus parâmetros de entrada. Essa configuração afeta apenas a nova execução. Por exemplo, suponha que a simultaneidade do trabalho seja 4 e que haja 4 concorrentes ativos em execução. Então, definir a simultaneidade como 3 não eliminará nenhuma das execuções ativas. No entanto, a partir de então, novas execuções são ignoradas, a menos que haja menos de 3 execuções ativas. Esse valor não pode exceder 1000. Definir esse valor como 0 faz com que todas as novas execuções sejam ignoradas. O comportamento do default é permitir a execução de apenas 1 concorrente. |
Lista
Endpoint |
Método HTTP |
|---|---|
|
|
Listar todos os cargos.
Exemplo
Solicitação
curl --netrc --request GET \
https://<databricks-instance>/api/2.0/jobs/list \
| jq .
Substitua <databricks-instance> pelo nome da instância do espaço de trabalho do Databricks, por exemplo, dbc-a1b2345c-d6e7.cloud.databricks.com.
Resposta
{
"jobs": [
{
"job_id": 1,
"settings": {
"name": "Nightly model training",
"new_cluster": {
"spark_version": "7.3.x-scala2.12",
"node_type_id": "r3.xlarge",
"aws_attributes": {
"availability": "ON_DEMAND"
},
"num_workers": 10
},
"libraries": [
{
"jar": "dbfs:/my-jar.jar"
},
{
"maven": {
"coordinates": "org.jsoup:jsoup:1.7.2"
}
}
],
"email_notifications": {
"on_start": [],
"on_success": [],
"on_failure": []
},
"timeout_seconds": 100000000,
"max_retries": 1,
"schedule": {
"quartz_cron_expression": "0 15 22 * * ?",
"timezone_id": "America/Los_Angeles",
"pause_status": "UNPAUSED"
},
"spark_jar_task": {
"main_class_name": "com.databricks.ComputeModels"
}
},
"created_time": 1457570074236
}
]
}
Estrutura de resposta
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Um conjunto de Job |
A lista do Job. |
Excluir
Endpoint |
Método HTTP |
|---|---|
|
|
Exclua um trabalho e envie um email para os endereços especificados em JobSettings.email_notifications. Nenhuma ação ocorrerá se o trabalho já tiver sido removido. Depois que o trabalho é removido, nem seus detalhes nem seu histórico de execução ficam visíveis na interface do usuário de trabalhos ou em API. O trabalho tem a garantia de ser removido após a conclusão dessa solicitação. Entretanto, as execuções que estavam ativas antes do recebimento dessa solicitação ainda podem estar ativas. Eles serão encerrados de forma assíncrona.
Exemplo
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/delete \
--data '{ "job_id": <job-id> }'
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<job-id>com o ID do trabalho, por exemplo,123.
Este exemplo usa um arquivo .netrc arquivo.
Obter
Endpoint |
Método HTTP |
|---|---|
|
|
Recuperar informações sobre um único trabalho.
Exemplo
Solicitação
curl --netrc --request GET \
'https://<databricks-instance>/api/2.0/jobs/get?job_id=<job-id>' \
| jq .
Ou:
curl --netrc --get \
https://<databricks-instance>/api/2.0/jobs/get \
--data job_id=<job-id> \
| jq .
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<job-id>com o ID do trabalho, por exemplo,123.
Resposta
{
"job_id": 1,
"settings": {
"name": "Nightly model training",
"new_cluster": {
"spark_version": "7.3.x-scala2.12",
"node_type_id": "r3.xlarge",
"aws_attributes": {
"availability": "ON_DEMAND"
},
"num_workers": 10
},
"libraries": [
{
"jar": "dbfs:/my-jar.jar"
},
{
"maven": {
"coordinates": "org.jsoup:jsoup:1.7.2"
}
}
],
"email_notifications": {
"on_start": [],
"on_success": [],
"on_failure": []
},
"webhook_notifications": {
"on_start": [
{
"id": "bf2fbd0a-4a05-4300-98a5-303fc8132233"
}
],
"on_success": [
{
"id": "bf2fbd0a-4a05-4300-98a5-303fc8132233"
}
],
"on_failure": []
},
"notification_settings": {
"no_alert_for_skipped_runs": false,
"no_alert_for_canceled_runs": false,
"alert_on_last_attempt": false
},
"timeout_seconds": 100000000,
"max_retries": 1,
"schedule": {
"quartz_cron_expression": "0 15 22 * * ?",
"timezone_id": "America/Los_Angeles",
"pause_status": "UNPAUSED"
},
"spark_jar_task": {
"main_class_name": "com.databricks.ComputeModels"
}
},
"created_time": 1457570074236
}
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico do trabalho sobre o qual se deseja recuperar informações. Esse campo é obrigatório. |
Estrutura de resposta
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico para esse trabalho. |
|
|
O nome de usuário do criador. Esse campo não será incluído na resposta se o usuário tiver sido excluído. |
|
Configurações para esse trabalho e toda a sua execução. Essas configurações podem ser atualizadas usando o Reset ou o ponto de extremidade Update. |
|
|
|
A hora em que esse Job foi criado em milissegundos de época (milissegundos desde 1/1/1970 UTC). |
Reset
Endpoint |
Método HTTP |
|---|---|
|
|
Substituir todas as configurações de um trabalho específico. Use o Update endpoint para atualizar parcialmente as configurações do trabalho.
Exemplo
Essa solicitação de exemplo torna o Job 2 idêntico ao Job 1 no exemplo de criação.
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/reset \
--data @reset-job.json \
| jq .
reset-job.json:
{
"job_id": 2,
"new_settings": {
"name": "Nightly model training",
"new_cluster": {
"spark_version": "7.3.x-scala2.12",
"node_type_id": "r3.xlarge",
"aws_attributes": {
"availability": "ON_DEMAND"
},
"num_workers": 10
},
"libraries": [
{
"jar": "dbfs:/my-jar.jar"
},
{
"maven": {
"coordinates": "org.jsoup:jsoup:1.7.2"
}
}
],
"email_notifications": {
"on_start": [],
"on_success": [],
"on_failure": []
},
"webhook_notifications": {
"on_start": [
{
"id": "bf2fbd0a-4a05-4300-98a5-303fc8132233"
}
],
"on_success": [
{
"id": "bf2fbd0a-4a05-4300-98a5-303fc8132233"
}
],
"on_failure": []
},
"notification_settings": {
"no_alert_for_skipped_runs": false,
"no_alert_for_canceled_runs": false,
"alert_on_last_attempt": false
},
"timeout_seconds": 100000000,
"max_retries": 1,
"schedule": {
"quartz_cron_expression": "0 15 22 * * ?",
"timezone_id": "America/Los_Angeles",
"pause_status": "UNPAUSED"
},
"spark_jar_task": {
"main_class_name": "com.databricks.ComputeModels"
}
}
}
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.O conteúdo de
reset-job.jsoncom campos apropriados para suas soluções.
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico do trabalho a ser redefinido. Esse campo é obrigatório. |
|
As novas configurações do trabalho. Essas configurações substituem completamente as configurações antigas. As alterações no campo |
Atualizar
Endpoint |
Método HTTP |
|---|---|
|
|
Adicionar, alterar ou remover configurações específicas de um trabalho existente. Use o botão Reset endpoint para sobrescrever todas as configurações do trabalho.
Exemplo
Essa solicitação de exemplo remove o biblioteca e adiciona as configurações de notificação do email ao Job 1 definido no exemplo de criação.
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/update \
--data @update-job.json \
| jq .
update-job.json:
{
"job_id": 1,
"new_settings": {
"existing_cluster_id": "1201-my-cluster",
"email_notifications": {
"on_start": [ "someone@example.com" ],
"on_success": [],
"on_failure": []
}
},
"fields_to_remove": ["libraries"]
}
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.O conteúdo de
update-job.jsoncom campos apropriados para suas soluções.
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico do trabalho a ser atualizado. Esse campo é obrigatório. |
|
As novas configurações do trabalho. Os campos de nível superior especificados em As alterações no campo |
|
|
Uma matriz de |
Remova os campos de nível superior nas configurações do trabalho. Não há suporte para a remoção de campos aninhados, exceto para entradas das matrizes Esse campo é opcional. |
execução agora
Importante
Um workspace é limitado a 1000 execuções de tarefas simultâneas. Será retornada a resposta
429 Too Many Requestsse você solicitar uma execução que não puder ser iniciada imediatamente.O número de jobs que um workspace pode criar em uma hora é limitado a 10000 (inclui "envio de execuções"). Esse limite também afeta os jobs criados pela API REST e pelos fluxos de trabalho do notebook.
O site workspace pode conter até 12.000 trabalhos salvos.
Um trabalho pode conter até 100 tarefas.
Endpoint |
Método HTTP |
|---|---|
|
|
executa um Job agora e retorna o run_id da execução acionada.
Dica
Se o senhor invocar o Create junto com a execução agora, poderá usar a execução submit endpoint em vez disso, o que lhe permite enviar sua carga de trabalho diretamente sem precisar criar um Job.
Exemplo
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/run-now \
--data @run-job.json \
| jq .
run-job.json:
Um exemplo de solicitação de um trabalho de notebook:
{
"job_id": 1,
"notebook_params": {
"name": "john doe",
"age": "35"
}
}
Um exemplo de solicitação para um trabalho em JAR:
{
"job_id": 2,
"jar_params": [ "john doe", "35" ]
}
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.O conteúdo de
run-job.jsoncom campos apropriados para suas soluções.
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
|
|
Uma matriz de |
Uma lista de parâmetros para o Job com JAR tarefa, por exemplo. |
|
Um mapa da ParamPair |
Um mapa da chave para os valores do Job com a tarefa Notebook, por exemplo. Se não for especificado em O senhor não pode especificar Notebook em conjunto com jar_params. A representação JSON desse campo (ou seja, o |
|
Uma matriz de |
Uma lista de parâmetros para o Job com Python tarefa, por exemplo. |
|
Uma matriz de |
Uma lista de parâmetros para Job com spark submit tarefa, por exemplo. |
|
|
Um token opcional para garantir a idempotência das solicitações de execução de trabalhos. Se já existir uma execução com os tokens fornecidos, a solicitação não criará uma nova execução, mas retornará o ID da execução existente. Se uma execução com os tokens fornecidos for excluída, será retornado um erro. Se o senhor especificar os tokens de idempotência, em caso de falha, poderá tentar novamente até que a solicitação seja bem-sucedida. Databricks garante que exatamente uma execução seja iniciada com esses tokens de idempotência. Esses tokens devem ter no máximo 64 caracteres. Para obter mais informações, consulte Como garantir a idempotência do Job. |
execução submit
Importante
Um workspace é limitado a 1000 execuções de tarefas simultâneas. Será retornada a resposta
429 Too Many Requestsse você solicitar uma execução que não puder ser iniciada imediatamente.O número de jobs que um workspace pode criar em uma hora é limitado a 10000 (inclui "envio de execuções"). Esse limite também afeta os jobs criados pela API REST e pelos fluxos de trabalho do notebook.
O site workspace pode conter até 12.000 trabalhos salvos.
Um trabalho pode conter até 100 tarefas.
Endpoint |
Método HTTP |
|---|---|
|
|
Envie uma execução única. Esse endpoint permite que o senhor envie uma carga de trabalho diretamente sem criar um trabalho. Use jobs/runs/get API para verificar o estado de execução depois que o trabalho for enviado.
Exemplo
Solicitação
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/runs/submit \
--data @submit-job.json \
| jq .
submit-job.json:
{
"run_name": "my spark task",
"new_cluster": {
"spark_version": "7.3.x-scala2.12",
"node_type_id": "r3.xlarge",
"aws_attributes": {
"availability": "ON_DEMAND"
},
"num_workers": 10
},
"libraries": [
{
"jar": "dbfs:/my-jar.jar"
},
{
"maven": {
"coordinates": "org.jsoup:jsoup:1.7.2"
}
}
],
"spark_jar_task": {
"main_class_name": "com.databricks.ComputeModels"
}
}
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.O conteúdo de
submit-job.jsoncom campos apropriados para suas soluções.
Estrutura da solicitação
Importante
Quando o senhor executa um Job em um novo Job cluster, o Job é tratado como uma carga de trabalho de computação de Jobs (automatizada) sujeita aos preços de computação de Jobs.
Quando o senhor executa um trabalho em um site existente clusters todo-propósito, ele é tratado como uma carga de trabalho de computação para todos os fins (interativa) sujeita aos preços de computação para todos os fins.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se existing_cluster_id, o ID de um cluster existente que será usado para toda a execução desse Job. Ao executar o Job em um cluster existente, talvez seja necessário reiniciar manualmente o cluster se ele parar de responder. Sugerimos que o Job seja executado no novo site clusters para maior confiabilidade. Se for new_cluster, uma descrição de um cluster que será criado para cada execução. Se estiver especificando um PipelineTask, esse campo poderá estar vazio. |
|
NotebookTask OU SparkJarTask OU SparkPythonTask OU SparkSubmitTask OU PipelineTask OU RunJobTask |
Se for Notebook, indica que esse trabalho deve ser executado em um Notebook. Esse campo não pode ser especificado em conjunto com spark_jar_task. Se spark_jar_task, indica que esse trabalho deve ser executado em JAR. Se for spark_python_task, indica que esse trabalho deve executar um arquivo Python. Se for spark_submit_task, indica que esse trabalho deve ser iniciado pelo script de envio do spark. Se for pipeline, indica que esse trabalho deve ser executado em Delta Live Tables pipeline. Se for execução, indica que esse trabalho deve executar outro trabalho. |
|
|
Um nome opcional para a execução. O valor de default é |
|
Um conjunto opcional de destinos do sistema a serem notificados quando a execução desse trabalho começar, for concluída ou falhar. |
|
|
Configurações de notificação opcionais que são usadas ao enviar notificações para cada um dos |
|
|
Uma matriz da biblioteca |
Uma lista opcional de bibliotecas a serem instaladas no site cluster que executará o trabalho. O valor default é uma lista vazia. |
|
|
Um tempo limite opcional aplicado a cada execução desse trabalho. O comportamento do default é não ter tempo limite. |
|
|
Um token opcional para garantir a idempotência das solicitações de execução de trabalhos. Se já existir uma execução com os tokens fornecidos, a solicitação não criará uma nova execução, mas retornará o ID da execução existente. Se uma execução com os tokens fornecidos for excluída, será retornado um erro. Se o senhor especificar os tokens de idempotência, em caso de falha, poderá tentar novamente até que a solicitação seja bem-sucedida. Databricks garante que exatamente uma execução seja iniciada com esses tokens de idempotência. Esses tokens devem ter no máximo 64 caracteres. Para obter mais informações, consulte Como garantir a idempotência do Job. |
lista de execução
Endpoint |
Método HTTP |
|---|---|
|
|
Lista de execução em ordem decrescente por tempo de início.
Observação
execução são removidos automaticamente após 60 dias. Se o senhor quiser consultá-los por mais de 60 dias, deve salvar os resultados de execução antigos antes que eles expirem. Para exportar usando a UI, consulte Exportar resultados da execução do trabalho. Para exportar usando o Jobs API, consulte execução export.
Exemplo
Solicitação
curl --netrc --request GET \
'https://<databricks-instance>/api/2.0/jobs/runs/list?job_id=<job-id>&active_only=<true-false>&offset=<offset>&limit=<limit>&run_type=<run-type>' \
| jq .
Ou:
curl --netrc --get \
https://<databricks-instance>/api/2.0/jobs/runs/list \
--data 'job_id=<job-id>&active_only=<true-false>&offset=<offset>&limit=<limit>&run_type=<run-type>' \
| jq .
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<job-id>com o ID do trabalho, por exemplo,123.“
<true-false>comtrueoufalse”.<offset>com o valoroffset.<limit>com o valorlimit.<run-type>com o valorrun_type.
Resposta
{
"runs": [
{
"job_id": 1,
"run_id": 452,
"number_in_job": 5,
"state": {
"life_cycle_state": "RUNNING",
"state_message": "Performing action"
},
"task": {
"notebook_task": {
"notebook_path": "/Users/donald@duck.com/my-notebook"
}
},
"cluster_spec": {
"existing_cluster_id": "1201-my-cluster"
},
"cluster_instance": {
"cluster_id": "1201-my-cluster",
"spark_context_id": "1102398-spark-context-id"
},
"overriding_parameters": {
"jar_params": ["param1", "param2"]
},
"start_time": 1457570074236,
"end_time": 1457570075149,
"setup_duration": 259754,
"execution_duration": 3589020,
"cleanup_duration": 31038,
"run_duration": 3879812,
"trigger": "PERIODIC"
}
],
"has_more": true
}
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se active_only for Se completed_only for |
|
|
O trabalho para o qual a execução será listada. Se omitido, o serviço Jobs listará a execução de todos os trabalhos. |
|
|
O deslocamento da primeira execução a retornar, em relação à execução mais recente. |
|
|
O número de execuções a retornar. Esse valor deve ser maior que 0 e menor que 1000. O valor de default é 20. Se uma solicitação especificar um limite de 0, o serviço usará o limite máximo. |
|
|
O tipo de execução a ser retornado. Para obter uma descrição dos tipos de execução, consulte execução. |
Estrutura de resposta
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de execução |
Uma lista de execuções, da mais recente para a menos recente. |
|
|
Se for verdadeiro, outras execuções que correspondam ao filtro fornecido estarão disponíveis para listagem. |
execução get
Endpoint |
Método HTTP |
|---|---|
|
|
Recupera os metadados de uma execução.
Observação
execução são removidos automaticamente após 60 dias. Se o senhor quiser consultá-los por mais de 60 dias, deve salvar os resultados de execução antigos antes que eles expirem. Para exportar usando a UI, consulte Exportar resultados da execução do trabalho. Para exportar usando o Jobs API, consulte execução export.
Exemplo
Solicitação
curl --netrc --request GET \
'https://<databricks-instance>/api/2.0/jobs/runs/get?run_id=<run-id>' \
| jq .
Ou:
curl --netrc --get \
https://<databricks-instance>/api/2.0/jobs/runs/get \
--data run_id=<run-id> \
| jq .
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<run-id>com o ID da execução, por exemplo,123.
Resposta
{
"job_id": 1,
"run_id": 452,
"number_in_job": 5,
"state": {
"life_cycle_state": "RUNNING",
"state_message": "Performing action"
},
"task": {
"notebook_task": {
"notebook_path": "/Users/someone@example.com/my-notebook"
}
},
"cluster_spec": {
"existing_cluster_id": "1201-my-cluster"
},
"cluster_instance": {
"cluster_id": "1201-my-cluster",
"spark_context_id": "1102398-spark-context-id"
},
"overriding_parameters": {
"jar_params": ["param1", "param2"]
},
"start_time": 1457570074236,
"end_time": 1457570075149,
"setup_duration": 259754,
"execution_duration": 3589020,
"cleanup_duration": 31038,
"run_duration": 3879812,
"trigger": "PERIODIC"
}
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico da execução para a qual se deseja recuperar os metadados. Esse campo é obrigatório. |
Estrutura de resposta
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico do trabalho que contém essa execução. |
|
|
O identificador canônico da execução. Esse ID é exclusivo em todas as execuções de todos os trabalhos. |
|
|
O número de sequência dessa execução entre todas as execuções do trabalho. Esse valor começa em 1. |
|
|
Se essa execução for uma repetição de uma tentativa de execução anterior, esse campo conterá a execução da tentativa original; caso contrário, será o mesmo que a execução. |
|
O resultado e os estados do ciclo de vida da execução. |
|
|
O programador cron que acionou essa execução, caso tenha sido acionado pelo programador periódico. |
|
|
A tarefa realizada pela execução, se houver. |
|
|
Um instantâneo da especificação cluster do trabalho quando essa execução foi criada. |
|
|
O cluster usado para essa execução. Se a execução for especificada para usar um novo cluster, esse campo será definido quando o serviço Jobs solicitar um cluster para a execução. |
|
|
Os parâmetros usados para essa execução. |
|
|
|
A hora em que essa execução foi iniciada em milissegundos de época (milissegundos desde 1/1/1970 UTC). Esse pode não ser o momento em que a tarefa começa a ser executada, por exemplo, se a tarefa estiver programada para ser executada em um novo cluster, esse é o momento em que a chamada de criação do cluster é emitida. |
|
|
A hora em que essa execução terminou em milissegundos de época (milissegundos desde 1/1/1970 UTC). Esse campo será definido como 0 se o trabalho ainda estiver em execução. |
|
|
O tempo, em milissegundos, necessário para configurar o cluster. Para a execução em um novo clusters, esse é o tempo de criação do cluster; para a execução em um clusters existente, esse tempo deve ser muito curto. A duração total da execução é a soma de |
|
|
O tempo, em milissegundos, que o comando levou para ser executado no site JAR ou no Notebook até ser concluído, falhar, atingir o tempo limite, ser cancelado ou encontrar um erro inesperado. A duração total da execução é a soma de |
|
|
O tempo, em milissegundos, necessário para encerrar o cluster e limpar os artefatos associados. A duração total da execução é a soma de |
|
|
O tempo, em milissegundos, que a execução do trabalho e todos os seus reparos levaram para terminar. Esse campo só é definido para a execução de trabalhos multitarefa e não para a execução de tarefas. A duração da execução de uma tarefa é a soma de |
|
O tipo de gatilho que disparou essa execução. |
|
|
|
O nome de usuário do criador. Esse campo não será incluído na resposta se o usuário tiver sido excluído |
|
|
O URL da página de detalhes da execução. |
execução exportação
Endpoint |
Método HTTP |
|---|---|
|
|
Exportar e recuperar a tarefa de execução do trabalho.
Observação
Somente a execução do Notebook pode ser exportada em formato HTML. A exportação de execuções de outros tipos falhará.
Exemplo
Solicitação
curl --netrc --request GET \
'https://<databricks-instance>/api/2.0/jobs/runs/export?run_id=<run-id>' \
| jq .
Ou:
curl --netrc --get \
https://<databricks-instance>/api/2.0/jobs/runs/export \
--data run_id=<run-id> \
| jq .
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<run-id>com o ID da execução, por exemplo,123.
Resposta
{
"views": [ {
"content": "<!DOCTYPE html><html><head>Head</head><body>Body</body></html>",
"name": "my-notebook",
"type": "NOTEBOOK"
} ]
}
Para extrair o HTML Notebook da resposta JSON, download e execute este scriptPython .
Observação
O corpo do Notebook no objeto __DATABRICKS_NOTEBOOK_MODEL é codificado.
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico da execução. Esse campo é obrigatório. |
|
Qual visualização exportar (CODE, DASHBOARDS ou ALL). padrão para CODE. |
Estrutura de resposta
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de ViewItem |
O conteúdo exportado em formato HTML (um para cada item do site view ). |
execução cancelar
Endpoint |
Método HTTP |
|---|---|
|
|
Cancelar a execução do trabalho. Como a execução é cancelada de forma assíncrona, a execução ainda pode estar em andamento quando essa solicitação for concluída. A execução será encerrada em breve. Se a execução já estiver em um terminal life_cycle_state, esse método não funcionará.
Esse endpoint valida que o parâmetro run_id é válido e, para parâmetros inválidos, retorna o código de status HTTP 400.
Exemplo
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/runs/cancel \
--data '{ "run_id": <run-id> }'
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<run-id>com o ID da execução, por exemplo,123.
Este exemplo usa um arquivo .netrc arquivo.
execução cancelar tudo
Endpoint |
Método HTTP |
|---|---|
|
|
Cancelar toda a execução ativa de um trabalho. Como a execução é cancelada de forma assíncrona, isso não impede que novas execuções sejam iniciadas.
Esse endpoint valida que o parâmetro job_id é válido e, para parâmetros inválidos, retorna o código de status HTTP 400.
Exemplo
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/runs/cancel-all \
--data '{ "job_id": <job-id> }'
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<job-id>com o ID do trabalho, por exemplo,123.
Este exemplo usa um arquivo .netrc arquivo.
execução get output
Endpoint |
Método HTTP |
|---|---|
|
|
Recuperar a saída e os metadados de uma única execução de tarefa. Quando uma tarefa do Notebook retorna um valor por meio da função dbutils.Notebook.exit() o senhor pode usar esse endpoint para recuperar esse valor. A Databricks restringe essa API a retornar os primeiros 5 MB da saída. Para retornar um resultado maior, o senhor pode armazenar os resultados do trabalho em um serviço de armazenamento cloud.
Esse endpoint valida que o parâmetro run_id é válido e, para parâmetros inválidos, retorna o código de status HTTP 400.
execução são removidos automaticamente após 60 dias. Se o senhor quiser consultá-los por mais de 60 dias, deve salvar os resultados de execução antigos antes que eles expirem. Para exportar usando a UI, consulte Exportar resultados da execução do trabalho. Para exportar usando o Jobs API, consulte execução export.
Exemplo
Solicitação
curl --netrc --request GET \
'https://<databricks-instance>/api/2.0/jobs/runs/get-output?run_id=<run-id>' \
| jq .
Ou:
curl --netrc --get \
https://<databricks-instance>/api/2.0/jobs/runs/get-output \
--data run_id=<run-id> \
| jq .
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<run-id>com o ID da execução, por exemplo,123.
Resposta
{
"metadata": {
"job_id": 1,
"run_id": 452,
"number_in_job": 5,
"state": {
"life_cycle_state": "TERMINATED",
"result_state": "SUCCESS",
"state_message": ""
},
"task": {
"notebook_task": {
"notebook_path": "/Users/someone@example.com/my-notebook"
}
},
"cluster_spec": {
"existing_cluster_id": "1201-my-cluster"
},
"cluster_instance": {
"cluster_id": "1201-my-cluster",
"spark_context_id": "1102398-spark-context-id"
},
"overriding_parameters": {
"jar_params": ["param1", "param2"]
},
"start_time": 1457570074236,
"setup_duration": 259754,
"execution_duration": 3589020,
"cleanup_duration": 31038,
"run_duration": 3879812,
"trigger": "PERIODIC"
},
"notebook_output": {
"result": "the maybe truncated string passed to dbutils.notebook.exit()"
}
}
Estrutura da solicitação
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico da execução. Para um trabalho com várias tarefas, esse é o |
Estrutura de resposta
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
NotebookOutput OU |
Se for Notebook, a saída de uma tarefa do Notebook, se disponível. Uma tarefa do Notebook que termina (com sucesso ou com falha) sem chamar Se for erro, uma mensagem de erro indicando por que a saída não está disponível. A mensagem não é estruturada e seu formato exato está sujeito a alterações. |
|
Todos os detalhes da execução, exceto a saída. |
execução delete
Endpoint |
Método HTTP |
|---|---|
|
|
Excluir uma execução não ativa. Retorna um erro se a execução estiver ativa.
Exemplo
curl --netrc --request POST \
https://<databricks-instance>/api/2.0/jobs/runs/delete \
--data '{ "run_id": <run-id> }'
Substituir:
<databricks-instance>com o nome da instância do espaço de trabalho do Databricks, por exemplo,dbc-a1b2345c-d6e7.cloud.databricks.com.<run-id>com o ID da execução, por exemplo,123.
Este exemplo usa um arquivo .netrc arquivo.
Estruturas de dados
Nesta secção:
Autoescala
Intervalo que define o número mínimo e máximo de cluster trabalhadores.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O número mínimo de trabalhadores para o qual o site cluster pode reduzir quando subutilizado. Esse também é o número inicial de trabalhadores que o site cluster terá após a criação. |
|
|
O número máximo de trabalhadores para o qual o cluster pode escalar quando sobrecarregado. max_workers deve ser estritamente maior que min_workers. |
AwsAttributes
Atributos definidos durante a criação do site cluster relacionados ao serviço da Web Amazon.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Os primeiros nós first_on_demand do cluster serão colocados em instâncias on-demand. Se esse valor for maior que 0, o nó do driver do cluster será colocado em uma instância sob demanda. Se esse valor for maior ou igual ao tamanho do cluster atual, todos os nós serão colocados em instâncias on-demand. Se esse valor for menor que o tamanho atual do cluster, os nós first_on_demand serão colocados em instâncias on-demand e os demais serão colocados em instâncias |
|
Tipo de disponibilidade usado para todos os nós subsequentes após os primeiros_on_demand. Observação: se first_on_demand for zero, esse tipo de disponibilidade será usado para todo o cluster. |
|
|
|
Identificador da zona de disponibilidade (AZ) na qual o cluster reside. Em default, a configuração tem um valor de auto, também conhecido como Auto-AZ. Com o Auto-AZ, o Databricks seleciona o AZ com base nos IPs disponíveis nas sub-redes do workspace e tenta novamente em outras zonas de disponibilidade se o AWS retornar erros de capacidade insuficiente. Se desejar, o senhor também pode especificar uma zona de disponibilidade a ser usada. Isso beneficia as contas que têm instâncias reservadas em uma AZ específica. Especifique o AZ como uma cadeia de caracteres (por exemplo, A lista de zonas disponíveis, bem como o valor default, pode ser encontrada usando o comando GET /api/2.0/clusters /list-zones ligar. |
|
|
Os nós para este cluster só serão colocados em instâncias AWS com este instance profile. Se omitido, os nós serão colocados em instâncias sem um instance profile. O instance profile deve ter sido adicionado anteriormente ao ambiente Databricks por um administrador do account. Esse recurso pode estar disponível apenas para determinados planos de clientes. |
|
|
O preço máximo para instâncias spot do AWS, como uma porcentagem do preço sob demanda do tipo de instância correspondente. Por exemplo, se esse campo for definido como 50 e o cluster precisar de uma nova instância spot |
|
O tipo de volumes EBS que serão lançados com esse cluster. |
|
|
|
O número de volumes lançados para cada instância. O senhor pode escolher até 10 volumes. Esse recurso só é ativado para os tipos de nós compatíveis. Os tipos de nós legados não podem especificar volumes personalizados do EBS. Para tipos de nós sem armazenamento de instância, pelo menos um volume EBS precisa ser especificado; caso contrário, haverá falha na criação do cluster. Esses volumes EBS serão montados em Se os volumes do EBS estiverem anexados, o Databricks configurará o Spark para usar somente os volumes do EBS para o armazenamento de arranhões, pois os dispositivos de arranhões de tamanho heterogêneo podem levar a uma utilização ineficiente do disco. Se nenhum volume EBS estiver anexado, o Databricks configurará o Spark para usar volumes de armazenamento de instância. Se os volumes EBS forem especificados, a configuração |
|
|
O tamanho de cada volume EBS (em GiB) lançado para cada instância. Para SSD propósito geral, esse valor deve estar no intervalo de 100 a 4096. Para Taxa de transferência otimizada HDD, esse valor deve estar dentro do intervalo 500 - 4096. Os volumes personalizados do EBS não podem ser especificados para os tipos de nós herdados(otimizados para memória e otimizados para compute). |
|
|
O número de IOPS por volume EBS gp3. Esse valor deve estar entre 3000 e 16000. O valor de IOPS e Taxa de transferência é calculado com base na documentação do site AWS para corresponder ao desempenho máximo de um volume gp2 com o mesmo tamanho de volume. Para obter mais informações, consulte a calculadora de limite de volume do EBS. |
|
|
A Taxa de transferência por volume do EBS gp3, em MiB por segundo. Esse valor deve estar entre 125 e 1000. |
Se nem ebs_volume_iops nem ebs_volume_throughput forem especificados, os valores serão inferidos a partir do tamanho do disco:
Tamanho do disco |
IOPS |
Taxa de transferência |
|---|---|---|
Maior que 1000 |
3 vezes o tamanho do disco, até 16000 |
250 |
Entre 170 e 1000 |
3000 |
250 |
abaixo 170 |
3000 |
125 |
AwsAvailability
O conjunto de tipos de disponibilidade do AWS suportados ao configurar nós para um cluster.
Tipo |
Descrição |
|---|---|
|
Use instâncias pontuais. |
|
Use instâncias sob demanda. |
|
De preferência, use instâncias spot, mas recorra a instâncias on-demand se não for possível adquirir instâncias spot (por exemplo, se os preços spot do AWS forem muito altos). |
ClusterInstance
Identificadores para o cluster e o contexto do Spark usados por uma execução. Esses dois valores juntos identificam um contexto de execução em todos os momentos.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico do cluster usado por uma execução. Esse campo está sempre disponível para execução no site clusters. Para execução em um novo clusters, ele fica disponível assim que o cluster é criado. Esse valor pode ser usado para view logs navegando para A resposta não incluirá esse campo se o identificador ainda não estiver disponível. |
|
|
O identificador canônico do contexto do Spark usado por uma execução. Esse campo será preenchido quando a execução começar. Esse valor pode ser usado para view o Spark UI navegando até A resposta não incluirá esse campo se o identificador ainda não estiver disponível. |
ClusterLogConf
Caminho para cluster log.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
DBFS localização de cluster log. O destino deve ser fornecido. Por exemplo,
S3 localização de cluster log. |
ClusterSpec
Importante
Quando o senhor executa um Job em um novo Job cluster, o Job é tratado como uma carga de trabalho de computação de Jobs (automatizada) sujeita aos preços de computação de Jobs.
Quando o senhor executa um trabalho em um site existente clusters todo-propósito, ele é tratado como uma carga de trabalho de computação para todos os fins (interativa) sujeita aos preços de computação para todos os fins.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se existing_cluster_id, o ID de um cluster existente que será usado para toda a execução desse Job. Ao executar o Job em um cluster existente, talvez seja necessário reiniciar manualmente o cluster se ele parar de responder. Sugerimos que o Job seja executado no novo site clusters para maior confiabilidade. Se for new_cluster, uma descrição de um cluster que será criado para cada execução. Se estiver especificando um PipelineTask, esse campo poderá estar vazio. |
|
Uma matriz da biblioteca |
Uma lista opcional de bibliotecas a serem instaladas no site cluster que executará o trabalho. O valor default é uma lista vazia. |
ClusterTag
Definição da tag de cluster.
Tipo |
Descrição |
|---|---|
|
O site key do tag. O comprimento de key deve estar entre 1 e 127 caracteres UTF-8, inclusive. Para obter uma lista de todas as restrições, consulte AWS Tag Restrictions: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions |
|
O valor da tag. O comprimento do valor deve ser menor ou igual a 255 caracteres UTF-8. Para obter uma lista de todas as restrições, consulte AWS Tag Restrictions: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions |
CronSchedule
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Uma expressão Cron usando a sintaxe do Quartz que descreve a programação de um trabalho. Consulte Cron Trigger para obter detalhes. Esse campo é obrigatório. |
|
|
Uma ID de fuso horário Java. O programar de um trabalho será resolvido com relação a esse fuso horário. Consulte Java TimeZone para obter detalhes. Esse campo é obrigatório. |
|
|
Indique se esse programar é pausa ou não. Ou "pausa" ou "UNPAUSED". |
DbfsStorageInfo
DBFS informações de armazenamento.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Destino do DBFS. Exemplo: |
EbsVolumeType
O Databricks oferece suporte aos tipos de volume EBS gp2 e gp3. Siga as instruções em gerenciar SSD storage para selecionar gp2 ou gp3 para seu workspace.
Tipo |
Descrição |
|---|---|
|
provisionamento de armazenamento extra usando AWS volumes EBS. |
|
provisionamento de armazenamento extra usando volumes AWS st1. |
FileStorageInfo
Informações sobre armazenamento de arquivos.
Observação
Esse tipo de local só está disponível para clusters configurados usando o Databricks Container Services.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Destino do arquivo. Exemplo: |
InitScriptInfo
Caminho para um init script.
Para obter instruções sobre como usar o script init com Databricks Container Servicesconsulte Use an init script.
Observação
O tipo de armazenamento de arquivos (nome do campo: file) só está disponível para clusters configurados usando o Databricks Container Services. Consulte FileStorageInfo.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
ou
|
DbfsStorageInfo (obsoleto) |
Localização do espaço de trabalho de init script. O destino deve ser fornecido. Por exemplo,
(Depreciado) DBFS localização de init script. O destino deve ser fornecido. Por exemplo,
S3 localização do site init script. O destino e a região ou o depósito devem ser fornecidos. Por exemplo,
|
Job
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico para esse trabalho. |
|
|
O nome de usuário do criador. Esse campo não será incluído na resposta se o usuário já tiver sido excluído. |
|
|
O nome de usuário com o qual o trabalho será executado. |
|
Configurações para esse trabalho e toda a sua execução. Essas configurações podem ser atualizadas usando o método |
|
|
|
A hora em que esse Job foi criado em milissegundos de época (milissegundos desde 1/1/1970 UTC). |
JobEmailNotifications
Importante
Os campos on_start, on_success e on_failure aceitam apenas caracteres latinos (conjunto de caracteres ASCII). O uso de caracteres não ASCII retornará um erro. Exemplos de caracteres não ASCII inválidos são os chineses, os kanjis japoneses e os emojis.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de |
Uma lista de endereços email a serem notificados quando uma execução começar. Se não for especificado na criação, redefinição ou atualização do trabalho, a lista estará vazia e as notificações não serão enviadas. |
|
Uma matriz de |
Uma lista de endereços email a serem notificados quando uma execução for concluída com êxito. Considera-se que uma execução foi concluída com êxito se terminar com um |
|
Uma matriz de |
Uma lista de endereços email a serem notificados quando uma execução não for concluída com êxito. Considera-se que uma execução foi concluída sem êxito se terminar com |
|
Uma matriz de |
Uma lista de endereços email a serem notificados quando a duração de uma execução exceder o limite especificado para as |
|
|
Se verdadeiro, não enviar email para os destinatários especificados em |
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando uma execução for iniciada. Se não for especificado na criação, redefinição ou atualização do trabalho, a lista estará vazia e as notificações não serão enviadas. Um máximo de 3 destinos pode ser especificado para a propriedade |
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando uma execução for concluída com êxito. Considera-se que uma execução foi concluída com êxito se terminar com um |
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando uma execução for concluída sem êxito. Considera-se que uma execução foi concluída sem êxito se terminar com |
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando a duração de uma execução exceder o limite especificado para as |
JobNotificationSettings
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se verdadeiro, não enviará notificações aos destinatários especificados em |
|
|
Se for verdadeiro, não enviará notificações aos destinatários especificados em |
|
|
Se verdadeiro, não enviará notificações aos destinatários especificados em |
Configurações de trabalho
Importante
Quando o senhor executa um Job em um novo Job cluster, o Job é tratado como uma carga de trabalho de computação de Jobs (automatizada) sujeita aos preços de computação de Jobs.
Quando o senhor executa um trabalho em um site existente clusters todo-propósito, ele é tratado como uma carga de trabalho de computação para todos os fins (interativa) sujeita aos preços de computação para todos os fins.
Configurações para um trabalho. Essas configurações podem ser atualizadas usando o método resetJob.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se existing_cluster_id, o ID de um cluster existente que será usado para toda a execução desse Job. Ao executar o Job em um cluster existente, talvez seja necessário reiniciar manualmente o cluster se ele parar de responder. Sugerimos que o Job seja executado no novo site clusters para maior confiabilidade. Se for new_cluster, uma descrição de um cluster que será criado para cada execução. Se estiver especificando um PipelineTask, esse campo poderá estar vazio. |
|
NotebookTask OU SparkJarTask OU SparkPythonTask OU SparkSubmitTask OU PipelineTask OU RunJobTask |
Se for Notebook, indica que esse trabalho deve ser executado em um Notebook. Esse campo não pode ser especificado em conjunto com spark_jar_task. Se spark_jar_task, indica que esse trabalho deve ser executado em JAR. Se for spark_python_task, indica que esse trabalho deve executar um arquivo Python. Se for spark_submit_task, indica que esse trabalho deve ser iniciado pelo script de envio do spark. Se for pipeline, indica que esse trabalho deve ser executado em Delta Live Tables pipeline. Se for execução, indica que esse trabalho deve executar outro trabalho. |
|
|
Um nome opcional para o trabalho. O valor de default é |
|
Uma matriz da biblioteca |
Uma lista opcional de bibliotecas a serem instaladas no site cluster que executará o trabalho. O valor default é uma lista vazia. |
|
Um conjunto opcional de endereços email que serão notificados quando a execução desse trabalho começar ou for concluída, bem como quando esse trabalho for excluído. O comportamento do default é não enviar nenhum e-mail. |
|
|
Um conjunto opcional de destinos do sistema a serem notificados quando a execução desse trabalho começar, for concluída ou falhar. |
|
|
Configurações de notificação opcionais que são usadas ao enviar notificações para cada um dos |
|
|
|
Um tempo limite opcional aplicado a cada execução desse trabalho. O comportamento do default é não ter tempo limite. |
|
|
Um número máximo opcional de vezes para tentar novamente uma execução malsucedida. Uma execução é considerada malsucedida se for concluída com o result_state |
|
|
Um intervalo mínimo opcional em milissegundos entre as tentativas. O comportamento do default é que as execuções malsucedidas são imediatamente repetidas. |
|
|
Uma política opcional para especificar se um trabalho deve ser tentado novamente quando atingir o tempo limite. O comportamento do default é não tentar novamente após o tempo limite. |
|
Um programador periódico opcional para esse trabalho. O comportamento do default é que o trabalho só será executado quando acionado ao clicar em "Executar agora" na interface do usuário do trabalho ou ao enviar uma solicitação API para |
|
|
|
Um número máximo opcional permitido de execução concorrente do trabalho. Defina esse valor se o senhor quiser poder executar várias execuções do mesmo trabalho simultaneamente. Isso é útil, por exemplo, se o senhor acionar o seu trabalho em uma programação frequente e quiser permitir que execuções consecutivas se sobreponham umas às outras, ou se quiser acionar várias execuções que diferem em seus parâmetros de entrada. Essa configuração afeta apenas a nova execução. Por exemplo, suponha que a simultaneidade do trabalho seja 4 e que haja 4 concorrentes ativos em execução. Então, definir a simultaneidade como 3 não eliminará nenhuma das execuções ativas. No entanto, a partir de então, novas execuções serão ignoradas, a menos que haja menos de 3 execuções ativas. Esse valor não pode exceder 1000. Definir esse valor como 0 faz com que todas as novas execuções sejam ignoradas. O comportamento do default é permitir a execução de apenas 1 concorrente. |
|
Um conjunto opcional de regras de integridade definidas para o trabalho. |
JobTask
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
NotebookTask OU SparkJarTask OU SparkPythonTask OU SparkSubmitTask OU PipelineTask OU RunJobTask |
Se for Notebook, indica que esse trabalho deve ser executado em um Notebook. Esse campo não pode ser especificado em conjunto com spark_jar_task. Se spark_jar_task, indica que esse trabalho deve ser executado em JAR. Se for spark_python_task, indica que esse trabalho deve executar um arquivo Python. Se for spark_submit_task, indica que esse trabalho deve ser iniciado pelo script de envio do spark. Se for pipeline, indica que esse trabalho deve ser executado em Delta Live Tables pipeline. Se for execução, indica que esse trabalho deve executar outro trabalho. |
EmpregosRegra de Saúde
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Especifica as métricas de saúde que estão sendo avaliadas para uma determinada regra de saúde. Os valores válidos são |
|
|
Especifica o operador usado para comparar o valor de métricas de saúde com o limite especificado. Os valores válidos são |
|
|
Especifica o valor limite que as métricas de saúde devem atender para cumprir a regra de saúde. |
EmpregosSaúdeRegras
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de JobsHealthRule |
Um conjunto opcional de regras de integridade que podem ser definidas para um trabalho. |
biblioteca
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se for jar, o URI do JAR a ser instalado. Há suporte para URIs DBFS e S3. Por exemplo: Se for egg, URI do egg a ser instalado. Há suporte para URIs DBFS e S3. Por exemplo: Se whl, URI do Se for pypi, especificação de uma biblioteca PyPI a ser instalada. A especificação do campo Se for Maven, especificação de uma Maven biblioteca a ser instalada. Por exemplo:
Se cran, especificação de uma biblioteca CRAN a ser instalada. |
MavenLibrary
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Coordenadas Maven no estilo Gradle. Por exemplo: |
|
|
Maven repo para instalar o pacote Maven. Se omitido, tanto o repositório Maven Central quanto o Spark pacote serão pesquisados. |
|
Uma matriz de |
Lista de dependências a serem excluídas. Por exemplo: Exclusões de dependência do Maven: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. |
NewCluster
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Se for worker, o número de nós worker que esse cluster deve ter. Um cluster tem um driver Spark e um executor de trabalho para um total de nós de trabalho + 1 Spark. Ao ler as propriedades de um cluster, esse campo reflete o número desejado de trabalhadores em vez do número atual real de trabalhadores. Por exemplo, se um cluster for redimensionado de 5 para 10 workers, esse campo será imediatamente atualizado para refletir o tamanho desejado de 10 workers, enquanto o worker listado em Se autoscale, os parâmetros necessários para escalar automaticamente clusters para cima e para baixo com base na carga. |
|
|
A versão Spark do cluster. Uma lista das versões disponíveis do Spark pode ser recuperada usando a chamada GET 2.0/clusters/spark-versions. Esse campo é obrigatório. |
|
Um objeto que contém um conjunto de configurações opcionais especificadas pelo usuário Spark par key-value. O senhor também pode passar uma cadeia de caracteres de opções extras JVM para o driver e o executor por meio de Exemplo de confs. do Spark: |
|
|
Atributos relacionados a clusters em execução no serviço da Web Amazon. Se não for especificado na criação do cluster, será usado um conjunto de valores do default. |
|
|
|
Esse campo codifica, por meio de um único valor, o recurso disponível para cada um dos nós do Spark neste cluster. Por exemplo, os nós Spark podem ser provisionados e otimizados para cargas de trabalho intensivas de memória ou compute Uma lista de tipos de nós disponíveis pode ser recuperada usando a chamada GET 2.0/clusters /list-node-types. Esse campo, o campo |
|
|
O tipo de nó do driver do Spark. Esse campo é opcional; se não for definido, o tipo de nó do driver será definido como o mesmo valor de |
|
Uma matriz de |
Conteúdo público do SSH key que será adicionado a cada nó Spark neste cluster. A chave privada correspondente pode ser usada para fazer login com o nome de usuário |
|
Um objeto que contém um conjunto de tags para cluster recurso. Databricks tags todos os recursos do cluster (como instâncias do AWS e volumes do EBS) com esses tags, além do padrão. Observação:
|
|
|
A configuração para fornecer logs do Spark a um destino de armazenamento de longo prazo. Somente um destino pode ser especificado para um cluster. Se o conf for fornecido, o logs será entregue ao destino a cada |
|
|
Uma matriz de InitScriptInfo |
A configuração para armazenar o script de inicialização. Qualquer número de scripts pode ser especificado. Os scripts são executados sequencialmente na ordem fornecida. Se |
|
Um objeto que contém um conjunto de variáveis de ambiente opcionais, especificadas pelo usuário, para key-value. O valor-chave par do formulário (X,Y) é exportado como está (ou seja, Para especificar um conjunto adicional de Exemplo Spark variável de ambiente: |
|
|
|
autoscale Local Storage (Armazenamento local em escala automática): quando ativado, este cluster adquire dinamicamente espaço em disco adicional quando seu Spark worker estiver com pouco espaço em disco. Esse recurso requer permissões específicas em AWS para funcionar corretamente - consulte Ativar armazenamento local de autoescala para obter detalhes. |
|
|
A ID opcional do pool de instâncias a ser usado para o nó do driver. O senhor também deve especificar |
|
|
O ID opcional do pool de instâncias a ser usado para os nós do cluster. Se |
NotebookOutput
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O valor passado para dbutils.Notebook.exit(). A Databricks restringe essa API para retornar o primeiro 1 MB do valor. Para um resultado maior, seu Job pode armazenar os resultados em um serviço de armazenamento cloud. Esse campo estará ausente se |
|
|
Se o resultado foi ou não truncado. |
NotebookTask
Todas as células de saída estão sujeitas ao tamanho de 8 MB. Se a saída de uma célula tiver um tamanho maior, o restante da execução será cancelado e a execução será marcada como falha. Nesse caso, parte do conteúdo gerado por outras células também pode estar faltando.
Se o senhor precisar de ajuda para encontrar a célula que está além do limite, execute o Notebook em um clusters todo-propósito e use essa técnica de salvamento automático do Notebook.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O caminho absoluto do Notebook a ser executado no site Databricks workspace. Esse caminho deve começar com uma barra. Esse campo é obrigatório. |
|
|
O registro de data e hora da revisão do Notebook. |
|
Um mapa da ParamPair |
Parâmetros básicos a serem usados para cada execução desse trabalho. Se a execução for iniciada por uma chamada para Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. Se o Notebook usar um parâmetro que não esteja especificado nos parâmetros de substituição Recupere esses parâmetros em um Notebook usando dbutils.widgets.get. |
ParamPair
Parâmetros baseados em nomes para tarefas de execução do Notebook.
Importante
Os campos dessa estrutura de dados aceitam apenas caracteres latinos (conjunto de caracteres ASCII). O uso de caracteres não ASCII retornará um erro. Exemplos de caracteres não ASCII inválidos são os chineses, os kanjis japoneses e os emojis.
Tipo |
Descrição |
|---|---|
|
Nome do parâmetro. Passe para dbutils.widgets.get para recuperar o valor. |
|
Valor do parâmetro. |
PipelineTask
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O nome completo da tarefa do pipeline Delta Live Tables a ser executada. |
PythonPyPiLibrary
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O nome do pacote PyPI a ser instalado. Uma especificação de versão exata opcional também é suportada. Exemplos: |
|
|
O repositório onde o pacote pode ser encontrado. Se não for especificado, o índice pip padrão será usado. |
RCranLibrary
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O nome do pacote CRAN a ser instalado. Esse campo é obrigatório. |
|
|
O repositório onde o pacote pode ser encontrado. Se não for especificado, é usado o repositório CRAN predefinido. |
execução
Todas as informações sobre uma execução, exceto sua saída. A saída pode ser recuperada separadamente com o método getRunOutput.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O identificador canônico do trabalho que contém essa execução. |
|
|
O identificador canônico da execução. Esse ID é exclusivo em todas as execuções de todos os trabalhos. |
|
|
O nome de usuário do criador. Esse campo não será incluído na resposta se o usuário já tiver sido excluído. |
|
|
O número de sequência dessa execução entre todas as execuções do trabalho. Esse valor começa em 1. |
|
|
Se essa execução for uma repetição de uma tentativa de execução anterior, esse campo conterá a execução da tentativa original; caso contrário, será o mesmo que a execução. |
|
O resultado e os estados do ciclo de vida da execução. |
|
|
O programador cron que acionou essa execução, caso tenha sido acionado pelo programador periódico. |
|
|
A tarefa realizada pela execução, se houver. |
|
|
Um instantâneo da especificação cluster do trabalho quando essa execução foi criada. |
|
|
O cluster usado para essa execução. Se a execução for especificada para usar um novo cluster, esse campo será definido quando o serviço Jobs solicitar um cluster para a execução. |
|
|
Os parâmetros usados para essa execução. |
|
|
|
A hora em que essa execução foi iniciada em milissegundos de época (milissegundos desde 1/1/1970 UTC). Esse pode não ser o momento em que a tarefa começa a ser executada, por exemplo, se a tarefa estiver programada para ser executada em um novo cluster, esse é o momento em que a chamada de criação do cluster é emitida. |
|
|
O tempo necessário para configurar o cluster em milissegundos. Para a execução em um novo clusters, esse é o tempo de criação do cluster; para a execução em um clusters existente, esse tempo deve ser muito curto. |
|
|
O tempo, em milissegundos, que o comando levou para ser executado no site JAR ou no Notebook até ser concluído, falhar, atingir o tempo limite, ser cancelado ou encontrar um erro inesperado. |
|
|
O tempo, em milissegundos, necessário para encerrar o cluster e limpar os artefatos associados. A duração total da execução é a soma da setup_duration, da execution_duration e da cleanup_duration. |
|
|
A hora em que essa execução terminou em milissegundos de época (milissegundos desde 1/1/1970 UTC). Esse campo será definido como 0 se o trabalho ainda estiver em execução. |
|
O tipo de gatilho que disparou essa execução. |
|
|
|
Um nome opcional para a execução. O valor de default é |
|
|
O URL da página de detalhes da execução. |
|
|
O tipo de execução.
|
|
|
O número de sequência dessa tentativa de execução para uma execução de trabalho acionada. A tentativa inicial de uma execução tem um attempt_number igual a 0. Se a tentativa inicial de execução falhar e o Job tiver uma política de novas tentativas ( |
RunJobTask
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Identificador exclusivo do trabalho a ser executado. Esse campo é obrigatório. |
RunLifeCycleState
O estado do ciclo de vida de uma execução. As transições de estado permitidas são:
QUEUED->PENDINGPENDING->RUNNING->TERMINATING->TERMINATEDPENDING->SKIPPEDPENDING->INTERNAL_ERRORRUNNING->INTERNAL_ERRORTERMINATING->INTERNAL_ERROR
Status |
Descrição |
|---|---|
|
A execução foi acionada, mas está na fila porque atingiu um dos seguintes limites:
O trabalho ou a execução deve ter o enfileiramento ativado para que possa atingir esse estado. |
|
A execução foi acionada. Se a execução concorrente máxima configurada do Job já tiver sido atingida, a execução passará imediatamente para o estado |
|
A tarefa dessa execução está sendo executada. |
|
A tarefa dessa execução foi concluída, e o cluster e o contexto de execução estão sendo limpos. |
|
A tarefa dessa execução foi concluída, e o cluster e o contexto de execução foram limpos. Esse estado é terminal. |
|
Essa execução foi abortada porque uma execução anterior do mesmo trabalho já estava ativa. Esse estado é terminal. |
|
Um estado excepcional que indica uma falha no serviço de Jobs, como uma falha de rede durante um longo período. Se uma execução em um novo cluster terminar no estado |
RunParameters
Parâmetros para essa execução. Apenas um dos jar_params, python_params ou Notebook deve ser especificado na solicitação run-now, dependendo do tipo de tarefa do trabalho. Os trabalhos com Spark JAR tarefa ou Python tarefa recebem uma lista de parâmetros baseados em posição, e os trabalhos com Notebook tarefa recebem um mapa de valores key.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de |
Uma lista de parâmetros para o Job com Spark JAR tarefa, por exemplo. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. |
|
Um mapa da ParamPair |
Um mapa da chave para os valores do Job com a tarefa Notebook, por exemplo. Se não for especificado em O Notebook não pode ser especificado em conjunto com jar_params. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. A representação JSON desse campo (ou seja, o |
|
Uma matriz de |
Uma lista de parâmetros para o Job com Python tarefa, por exemplo. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. Importante Esses parâmetros aceitam apenas caracteres latinos (conjunto de caracteres ASCII). O uso de caracteres não ASCII retornará um erro. Exemplos de caracteres inválidos e não ASCII são os caracteres chineses, kanjis japoneses e emojis. |
|
Uma matriz de |
Uma lista de parâmetros para Job com spark submit tarefa, por exemplo. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. Importante Esses parâmetros aceitam apenas caracteres latinos (conjunto de caracteres ASCII). O uso de caracteres não ASCII retornará um erro. Exemplos de caracteres inválidos e não ASCII são os caracteres chineses, kanjis japoneses e emojis. |
RunResultState
O estado do resultado da execução.
Se
life_cycle_state=TERMINATED: se a execução tiver uma tarefa, é garantido que o resultado esteja disponível e ele indica o resultado da tarefa.Se
life_cycle_state=PENDING,RUNNINGouSKIPPED, o estado do resultado não está disponível.Se
life_cycle_state=TERMINATINGou lifecyclestate =INTERNAL_ERROR: o estado do resultado estará disponível se a execução tiver uma tarefa e gerenciar para começar.
Uma vez disponível, o estado do resultado nunca muda.
Status |
Descrição |
|---|---|
|
A tarefa foi concluída com êxito. |
|
A tarefa foi concluída com um erro. |
|
A execução foi interrompida após atingir o tempo limite. |
|
A execução foi cancelada por solicitação do usuário. |
Estado de execução
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma descrição da localização atual de uma execução no ciclo de vida da execução. Esse campo está sempre disponível na resposta. |
|
|
O estado do resultado de uma execução. Se não estiver disponível, a resposta não incluirá esse campo. Consulte RunResultState para obter detalhes sobre a disponibilidade de result_state. |
|
|
|
Se uma execução foi cancelada manualmente por um usuário ou pelo programador porque a execução atingiu o tempo limite. |
|
|
Uma mensagem descritiva do estado atual. Esse campo não é estruturado e seu formato exato está sujeito a alterações. |
S3StorageInfo
S3 informações de armazenamento.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Destino S3. Por exemplo: |
|
|
Região S3. Por exemplo: |
|
|
Armazém S3. Por exemplo: |
|
|
(Opcional)Habilite a criptografia do lado do servidor, |
|
|
(Opcional) O tipo de criptografia, que pode ser |
|
|
(Opcional) KMS key usado se a criptografia estiver ativada e o tipo de criptografia estiver definido como |
|
|
(Opcional) Defina a lista de controle de acesso fixo. Por exemplo: |
SparkConfPair
Spark configuration par key-value.
Tipo |
Descrição |
|---|---|
|
Um nome de propriedade de configuração. |
|
O valor da propriedade de configuração. |
SparkEnvPair
Spark variável de ambiente par key-value.
Importante
Ao especificar a variável de ambiente em um Job cluster, os campos dessa estrutura de dados aceitam apenas caracteres latinos (conjunto de caracteres ASCII). O uso de caracteres não ASCII retornará um erro. Exemplos de caracteres inválidos e não ASCII são os caracteres chineses, kanjis japoneses e emojis.
Tipo |
Descrição |
|---|---|
|
Um nome de variável de ambiente. |
|
O valor da variável de ambiente. |
SparkJarTask
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Depreciado desde 04/2016. Em vez disso, forneça um |
|
|
O nome completo da classe contém o método principal a ser executado. Esta classe deve estar contida em um JAR fornecido como uma biblioteca. O código deve usar |
|
Uma matriz de |
Parâmetros passados para o método principal. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. |
SparkPythonTask
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
O URI do arquivo Python a ser executado. Há suporte para caminhos DBFS e S3. Esse campo é obrigatório. |
|
Uma matriz de |
Parâmetros da linha de comando passados para o arquivo Python. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. |
SparkSubmitTask
Importante
O senhor pode invocar Spark submit tarefa somente no novo clusters.
Na especificação new_cluster,
librariesespark_confnão são compatíveis. Em vez disso, use--jarse--py-filespara adicionar Java e Python biblioteca e--confpara definir a configuração de Spark.master,deploy-modeeexecutor-coressão configurados automaticamente pelo Databricks; o senhor não pode especificá-los nos parâmetros.Em default, o Spark submit Job usa toda a memória disponível (excluindo a memória reservada para o Databricks serviço). O senhor pode definir
--driver-memorye--executor-memorycom um valor menor para deixar algum espaço para o uso fora da pilha.Os argumentos
--jars,--py-files,--filessuportam caminhos DBFS e S3.
Por exemplo, supondo que o JAR seja carregado para DBFS, o senhor pode executar SparkPi definindo os seguintes parâmetros.
{
"parameters": [
"--class",
"org.apache.spark.examples.SparkPi",
"dbfs:/path/to/examples.jar",
"10"
]
}
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de |
Parâmetros de linha de comando passados para o spark submit. Use Passar contexto sobre a execução do trabalho para a tarefa do trabalho para definir parâmetros que contenham informações sobre a execução do trabalho. |
TriggerType
Esses são os tipos de acionadores que podem disparar uma execução.
Tipo |
Descrição |
|---|---|
|
programar que aciona periodicamente a execução, como um programador cron. |
|
Gatilhos únicos que disparam uma única execução. Isso ocorre quando o senhor aciona uma única execução sob demanda por meio da interface do usuário ou da API. |
|
Indica uma execução que é acionada como uma nova tentativa de uma execução que falhou anteriormente. Isso ocorre quando o senhor solicita a reexecução do trabalho em caso de falhas. |
ExibirItem
O conteúdo exportado está no formato HTML. Por exemplo, se o site view a ser exportado for dashboards, uma cadeia de caracteres HTML será retornada para cada dashboard.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Conteúdo do site view. |
|
|
Nome do item view. No caso do código view, o nome do Notebook. No caso do painel view, o nome do painel. |
|
Tipo do item view. |
ViewType
Tipo |
Descrição |
|---|---|
|
Notebook view item. |
|
Dashboard view item. |
ViewsToExport
visualização a ser exportada: código, todos os painéis ou todos.
Tipo |
Descrição |
|---|---|
|
Código view do Notebook. |
|
Visualização de todo o painel do Notebook. |
|
Todas as visualizações do Notebook. |
Webhook
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Identificador que faz referência a um destino de notificação do sistema. Esse campo é obrigatório. |
WebhookNotifications
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando uma execução for iniciada. Se não for especificado na criação, redefinição ou atualização do trabalho, a lista estará vazia e as notificações não serão enviadas. Um máximo de 3 destinos pode ser especificado para a propriedade |
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando uma execução for concluída com êxito. Considera-se que uma execução foi concluída com êxito se terminar com um |
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando uma execução for concluída sem êxito. Considera-se que uma execução foi concluída sem sucesso se terminar com |
|
Uma matriz de Webhook |
Uma lista opcional de destinos do sistema a serem notificados quando a duração de uma execução exceder o limite especificado para as |
WorkspaceStorageInfo
informações sobre o armazenamento do espaço de trabalho.
Nome do campo |
Tipo |
Descrição |
|---|---|---|
|
|
Destino do arquivo. Exemplo: |