最近更新时间:2023.05.11 16:26:02
首次发布时间:2023.05.11 16:17:41
调用 ModifyApplication 接口,修改 Spark 任务。
一般是开发人员(Project_Dev )有权限修改 Spark 任务,请确保操作者已被添加为项目成员并为其关联角色,请参见权限概述。
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ApplicationTrn | string | 是 | 1647**4065 | 任务 ID。 |
ApplicationName | string | 否 | spark-application-3 | 任务名称。 |
DeployRequest | object(POSTApiV1AppUpdateDeployRequest) | 否 | - | 任务部署策略,详情请参见 POSTApiV1AppUpdateDeployRequest 数据结构。 |
Dependency | object(POSTApiV1AppUpdateDependency) | 否 | - | 任务的依赖文件,详情请参见 POSTApiV1AppUpdateDependency 数据结构。 |
MainClass | string | 否 | com.bytedance.openplatform.SparkPi | Jar 类型任务的启动类。 |
Args | string | 否 | 3 60 | 任务启动类的参数。 |
SqlText | string | 否 | select * from | SQL 语句。 |
Conf | map<string,string> | 否 | { | 任务额外自定义的配置参数。 |
EngineVersion | string | 否 | SPARK_VERSION_3_0_1_OS | 引擎版本。
|
Jar | string | 否 | 5eb5896a**70108933 | 任务资源文件路径或元数据 ID。
|
Image | string | 否 | 192.168..:30004/open_platform/streamx:888 | 用户自定义镜像。 |
POSTApiV1AppUpdateDeployRequest 数据结构
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
Priority | string | 否 | 4 | 任务优先级。 |
ResourcePoolTrn | string | 否 | doc-resource-1-***226 | 任务运行资源池的唯一标识符。 |
SchedulePolicy | string | 否 | DRF | 根据需求配置任务调度策略:
|
ScheduleTimeout | string | 否 | 0 | 设置为 GANG 调度策略时,需要设置调度时长,单位为秒。 |
POSTApiV1AppUpdateDependency 数据结构
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
Archives | list | 否 | ["file_id", "tos://***"] | Spark 任务的依赖文件,支持文件路径或元数据 ID。 |
Jars | list | 否 | ["file_id", "tos://***"] | Spark 任务的依赖文件,支持文件路径或元数据 ID。 |
Files | list | 否 | ["file_id", "tos://***"] | Spark 任务的依赖文件,支持文件路径或元数据 ID。 |
PyFiles | list | 否 | ["file_id", "tos://***"] | Spark 任务的依赖文件,支持文件路径或元数据 ID。 |
参数 | 类型 | 示例值 | 说明 |
---|---|---|---|
Status | String | SUCCESSFUL | 修改 Spark 任务返回的状态:
|
Message | String | - | 提示信息。 |
POST https://open.volcengineapi.com?Action=ModifyApplication&Version=2021-06-01 Content-Type: application/json Region: cn-beijing ServiceName: spark { "ApplicationName": "spark-application-3", "DeployRequest": { "Priority": "4", "ResourcePoolTrn": "doc-resource-1-***226", "SchedulePolicy": "DRF", "ScheduleTimeout": "0" }, "SqlText": "select * from `docdb`.`hivetable`;", "ApplicationTrn": "1647**4065" }
{ "ResponseMetadata": { "RequestId": "20230417183442B82F0A9993552876E552", "Action": "ModifyApplication", "Version": "2021-06-01", "Service": "spark", "Region": "cn-beijing" }, "Result": { "Status": "SUCCESSFUL", "Message": "" } }