Actualiza la definición y la programación de un flujo de trabajo.
Pruébelo ahora
Test
Autorización de RAM
|
Action |
Nivel de acceso |
Tipo de recurso |
Clave de condición |
Acción dependiente |
|
emr-serverless-spark:UpdateProcessDefinitionWithSchedule |
none |
*Todos los recursos.
|
Ninguna | Ninguna |
Sintaxis de la solicitud
PUT /dolphinscheduler/projects/{bizId}/process-definition/{code} HTTP/1.1
Parámetros de ruta
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| bizId |
string |
Sí |
El ID del espacio de trabajo. |
w-d8******** |
| code |
integer |
Sí |
El ID de la definición de la tarea. |
12************ |
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| productNamespace |
string |
Sí |
El código del producto. |
SS |
| name |
string |
Sí |
El nombre del flujo de trabajo. |
ods_batch_workflow |
| description |
string |
No |
La descripción del flujo de trabajo. |
ods batch workflow |
| timeout |
integer |
No |
El tiempo de espera predeterminado para la ejecución del flujo de trabajo. |
300 |
| taskDefinitionJson |
array<object> |
Sí |
La matriz JSON de definiciones de tareas, que contiene la descripción de todas las tareas del flujo de trabajo. |
|
|
array<object> |
Sí |
El objeto JSON de una definición de tarea, que contiene la descripción de una tarea en el flujo de trabajo. |
||
| code |
integer |
Sí |
El ID de la definición de la tarea. |
23************ |
| description |
string |
No |
La descripción de la definición de la tarea. |
ods transform task |
| alertEmailAddress |
string |
No |
La dirección de correo electrónico para las notificaciones de alertas. |
foo_bar@spark.alert.invalid.com |
| startAlertEnable |
boolean |
No |
Especifica si se deben habilitar las alertas para el inicio de la tarea. |
true |
| failAlertEnable |
boolean |
No |
Especifica si se deben habilitar las alertas para los errores de la tarea. |
true |
| failRetryTimes |
integer |
No |
El número de reintentos permitidos después de un error de tarea. |
1 |
| name |
string |
Sí |
El nombre de la tarea. |
ods_transform_task |
| taskParams |
object |
Sí |
Los parámetros de la definición de la tarea. |
|
| workspaceBizId |
string |
Sí |
El ID del espacio de trabajo. |
w-d8******** |
| taskBizId |
string |
Sí |
El ID de la tarea de desarrollo de datos. |
TSK-d87****************** |
| resourceQueueId |
string |
Sí |
El nombre de la cola utilizada para ejecutar la tarea. |
root_queue |
| sparkDriverCores |
integer |
No |
El número de núcleos para el controlador de Spark. |
1 |
| sparkExecutorCores |
integer |
No |
El número de núcleos para el ejecutor de Spark. |
1 |
| sparkDriverMemory |
integer |
No |
El tamaño de memoria para el controlador de Spark. |
4g |
| sparkExecutorMemory |
integer |
No |
El tamaño de memoria para el ejecutor de Spark. |
4g |
| sparkConf |
array<object> |
No |
Las configuraciones de la tarea de Spark. |
|
|
object |
No |
Las configuraciones de la tarea de Spark. |
||
| key |
string |
No |
La clave de la configuración de Spark. |
spark.dynamicAllocation.enabled |
| value |
string |
No |
El valor de la configuración de Spark. |
true |
| sparkVersion |
string |
No |
La versión del motor de Spark. |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| sparkLogLevel |
string |
No |
El nivel de registro de Spark. |
INFO |
| sparkLogPath |
string |
No |
La ruta de registro para el nodo de Spark. |
oss://data***/spark/logs |
| displaySparkVersion |
string |
No |
La versión de visualización del motor de Spark. |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| fusion |
boolean |
No |
Especifica si se debe habilitar la aceleración del motor Fusion. |
false |
| environmentId |
string |
No |
El ID del entorno. |
ev-h************* |
| type |
string |
No |
El tipo de trabajo de Spark. |
SQL |
| localParams |
array<object> |
No |
La lista de parámetros locales para la tarea. |
|
|
object |
No |
|||
| prop |
string |
No |
El nombre del parámetro. |
testGlobalParam |
| direct |
string |
No |
La dirección del parámetro. Valores válidos: IN (entrada) y OUT (salida). |
IN |
| type |
string |
No |
El tipo de datos del parámetro. |
VARCHAR |
| value |
string |
No |
El valor del parámetro. |
testGlobalParam |
| taskType |
string |
Sí |
El tipo de nodo del flujo de trabajo. |
EMR-SERVERLESS-SPARK |
| timeout |
integer |
No |
El tiempo de espera predeterminado para la ejecución de la tarea. |
30 |
| tags |
object |
No |
Las etiquetas. |
|
|
string |
No |
La cadena JSON de pares clave-valor de etiquetas. |
“{\"tagkey\":\"tagvalue\"}” |
|
| taskRelationJson |
array<object> |
Sí |
La matriz JSON de dependencias de tareas, que contiene las dependencias entre todas las tareas del flujo de trabajo. preTaskCode especifica el ID de la tarea precedente, y postTaskCode especifica el ID de la tarea subsiguiente. Cada tarea debe tener un ID único. Si un nodo de tarea no tiene una tarea precedente, debe agregar una dependencia con preTaskCode establecido en 0. |
|
|
object |
Sí |
El objeto JSON de una dependencia de tarea, que contiene la dependencia entre las tareas del flujo de trabajo. preTaskCode especifica el ID de la tarea precedente, y postTaskCode especifica el ID de la tarea subsiguiente. Cada tarea debe tener un ID único. Si un nodo de tarea no tiene una tarea precedente, debe agregar una dependencia con preTaskCode establecido en 0. |
||
| name |
string |
Sí |
El nombre de la relación de topología de tareas. Establezca este parámetro con el nombre del flujo de trabajo. |
ods batch workflow |
| preTaskCode |
integer |
Sí |
El ID de la tarea precedente. |
16************ |
| preTaskVersion |
integer |
Sí |
La versión de la tarea precedente. |
1 |
| postTaskCode |
integer |
Sí |
El ID de la tarea subsiguiente. |
19************ |
| postTaskVersion |
integer |
Sí |
La versión de la tarea subsiguiente. |
1 |
| executionType |
string |
Sí |
La estrategia de ejecución. |
PARALLEL |
| alertEmailAddress |
string |
No |
La dirección de correo electrónico para las notificaciones de alertas. |
foo_bar@spark.alert.invalid.com |
| schedule |
object |
No |
La estructura de programación. |
|
| startTime |
string |
No |
La hora de inicio. Formato: AAAA-MM-DD HH:mm:ss. |
2024-12-23 16:13:27 |
| endTime |
string |
No |
La hora de finalización de la programación. Formato: AAAA-MM-DD HH:mm:ss. |
2025-12-23 16:13:27 |
| crontab |
string |
No |
La expresión cron para la programación. |
0 0 0 * * ? |
| timezoneId |
string |
No |
El ID de la zona horaria. |
Asia/Shanghai |
| retryTimes |
integer |
No |
El número de reintentos. |
1 |
| taskParallelism |
integer |
No |
El nivel de concurrencia para la ejecución de nodos del flujo de trabajo. |
1 |
| tags |
object |
No |
Las etiquetas. |
|
|
string |
No |
La cadena JSON de pares clave-valor de etiquetas. |
“{\"tagkey\":\"tagvalue\"}” |
|
| resourceQueue |
string |
No |
La cola de recursos. |
root_queue |
| releaseState |
string |
No |
El estado en línea del flujo de trabajo. |
ONLINE |
| runAs |
string |
No |
El usuario de ejecución. |
113*************** |
| publish |
boolean |
No |
Especifica si se debe publicar el flujo de trabajo. |
true |
| regionId |
string |
No |
El ID de la región. |
cn-hangzhou |
| globalParams |
array<object> |
No |
La lista de parámetros globales para el flujo de trabajo. |
|
|
object |
No |
|||
| prop |
string |
No |
El nombre del parámetro. |
testGlobalParam |
| value |
string |
No |
El valor del parámetro. |
testGlobalParam |
| direct |
string |
No |
La dirección del parámetro. Valores válidos: IN (entrada) y OUT (salida). |
IN |
| type |
string |
No |
El tipo de datos del parámetro. |
VARCHAR |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Esquema de la respuesta. |
||
| requestId |
string |
El ID de la solicitud. |
DD6B1B2A-5837-5237-ABE4-FF0C8944**** |
| code |
integer |
El código de retorno del backend de la API. |
1400009 |
| msg |
string |
La descripción detallada del código de la solicitud. |
No permission for resource action |
| success |
string |
Indica si la solicitud se realizó correctamente. |
true |
| failed |
string |
El número de fallas. |
false |
| data |
object |
Los datos de la respuesta. |
|
| id |
string |
El número de la definición del flujo de trabajo. |
123223 |
| code |
string |
El ID de la definición del flujo de trabajo. |
12*********** |
| name |
string |
El nombre de la definición del flujo de trabajo. |
ods_batch_workflow |
| version |
integer |
El número de versión. |
1 |
| releaseState |
string |
El estado en línea del flujo de trabajo. |
ONLINE |
| bizId |
string |
El ID del espacio de trabajo. |
alicloud_ack_one_cluster |
| description |
string |
La descripción de la definición de la tarea. |
1 |
| createTime |
string |
La hora de creación de la definición del flujo de trabajo. La hora está en UTC y sigue el formato ISO 8601. |
2024-09-05T02:03:19Z |
| updateTime |
string |
La hora de actualización de la definición del flujo de trabajo. La hora está en UTC y sigue el formato ISO 8601. |
2024-03-05T06:24:27Z |
| userId |
string |
El ID del usuario de programación. |
113********* |
| userName |
string |
El nombre del usuario de programación. |
w-******** |
| projectName |
string |
El nombre del proyecto al que pertenece el flujo de trabajo. |
w-******** |
| executionType |
string |
La estrategia de ejecución. |
SERIAL |
| alertEmailAddress |
string |
La dirección de correo electrónico de alertas. |
foo_bar@spark.alert.invalid.com |
| startTime |
string |
La hora de inicio de la programación. |
0 |
| endTime |
string |
La hora de fin del intervalo de tiempo de la tarea. La hora es una marca de tiempo UNIX en milisegundos. |
1710432000000 |
| timezoneId |
string |
El ID de la zona horaria. |
Asia/Shanghai |
| crontab |
string |
La expresión cron para la programación. |
0 0 0 * * ? |
| versionHashCode |
string |
El código hash de la versión. |
dwerf********* |
| httpStatusCode |
integer |
El código de estado HTTP. |
200 |
Ejemplos
Respuesta exitosa
JSON Formato
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
"code": 1400009,
"msg": "No permission for resource action",
"success": "true",
"failed": "false",
"data": {
"id": "123223",
"code": "12***********",
"name": "ods_batch_workflow",
"version": 1,
"releaseState": "ONLINE",
"bizId": "alicloud_ack_one_cluster",
"description": "1",
"createTime": "2024-09-05T02:03:19Z",
"updateTime": "2024-03-05T06:24:27Z",
"userId": "113*********",
"userName": "w-********",
"projectName": "w-********",
"executionType": "SERIAL",
"alertEmailAddress": "foo_bar@spark.alert.invalid.com\n",
"startTime": "0",
"endTime": "1710432000000",
"timezoneId": "Asia/Shanghai\n",
"crontab": "0 0 0 * * ?\n",
"versionHashCode": "dwerf*********"
},
"httpStatusCode": 200
}
Códigos de error
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.