网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

查询作业列表

更新时间:2024-04-09 GMT+08:00
分享

功能介绍

查询当前用户的作业列表,可以根据作业ID作为ID,查询大于ID或小于ID的限定条数的作业,默认查询全部状态的作业,也可以设定运行中或其他状态条件。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v1.0/{project_id}/streaming/jobs

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    表2 query参数说明

    参数名称

    是否必选

    参数类型

    说明

    job_type

    String

    作业类型:

    • flink_sql_job:flink sql作业
    • flink_opensource_sql_job:flink opensource sql作业
    • flink_sql_edge_job:flink sql边缘作业
    • flink_jar_job:flink自定义作业

    status

    String

    作业状态码。

    作业的状态如下:

    • job_init:草稿
    • job_submitting:提交中
    • job_submit_fail:提交失败
    • job_running:运行中(开始计费,提交作业后,返回正常结果)
    • job_running_exception:运行异常(停止计费。作业发生运行时异常,停止运行作业)
    • job_downloading:下载中
    • job_idle:空闲
    • job_canceling:停止中
    • job_cancel_success:已停止
    • job_cancel_fail:停止失败
    • job_savepointing:保存点创建中
    • job_arrearage_stopped:因欠费被停止(结束计费。用户账户欠费,作业停止)
    • job_arrearage_recovering:欠费作业恢复中(用户账户欠费,账户充值,作业恢复中)
    • job_finish:已完成

    queue_name

    String

    队列名称。

    order

    String

    查询结果排序。

    • asc:按照时间顺序升序排列
    • desc:按照时间顺序降序排列

    默认为“desc”

    limit

    Integer

    返回的数据条数。默认为“10”,最大值为“100”

    name

    String

    作业名称。长度限制:0-57个字符。

    offset

    Integer

    作业偏移量。

    root_job_id

    Integer

    边缘父作业ID, 用于查询指定边缘作业的子作业。不使用该参数时, 查询所有非边缘作业和边缘父作业, 不包括边缘子作业。

    show_detail

    Boolean

    是否返回作业详情信息。默认为“false”。为“true”时,返回作业详情。具体可见查询作业详情

    user_name

    String

    用户名,可作为筛选条件。

    tags

    String

    指定标签过滤。

请求消息

无请求参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

String

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

job_list

Object

作业列表信息。请参见表4

表4 job_list参数说明

参数名称

是否必选

参数类型

说明

total_count

Integer

作业查询结果条数。

jobs

Array of Objects

作业信息。请参见表5

表5 Jobs参数说明

参数名称

是否必选

参数类型

说明

job_id

Long

作业ID。

name

String

作业名称。长度限制:0-57个字符。

desc

String

作业描述。长度限制:0-512个字符。

user_name

String

用户名,当“show_detail”“false”时独有。

job_type

String

作业类型。

  • flink_sql_job:flink sql作业
  • flink_opensource_sql_job:flink opensource sql作业
  • flink_sql_edge_job:flink sql边缘作业
  • flink_jar_job:flink自定义作业

status

String

作业状态。

status_desc

String

作业状态描述。

create_time

Long

作业创建时间。

start_time

Long

作业启动时间。“0”表示尚未启动。

duration

Long

作业运行时长。 单位ms,“show_detail”“false”时独有。

root_id

Long

父作业ID。“show_detail”“false”时独有。

graph_editor_enabled

Boolean

作业的流图是否可编辑。“true”表示作业的流图可以编辑,“false”表示作业的流图不可以编辑。

has_savepoint

Boolean

作业是否有保存点。“true”表示作业有保存点,“false”表示作业没有保存点。

user_id

String

作业所属用户标识。 “show_detail”“true”时独有。

project_id

String

作业所属项目标识。 “show_detail”“true”时独有。

sql_body

String

Stream SQL语句。 “”“show_detail”“false”时独有。

run_mode

String

作业运行模式。包括共享、独享模式和边缘节点。“show_detail”“true”时独有。

  • shared_cluster:共享
  • exclusive_cluster:独享
  • edge_node:边缘节点

job_config

Object

作业配置。 “show_detail”“false”时独有。具体参数说明请参见表6

main_class

String

jar包主类。“show_detail”“false”时独有。

entrypoint_args

String

jar包作业运行参数。多个参数之间用空格分隔。“show_detail”“true”时独有。

execution_graph

String

作业执行计划。“show_detail”“false”时独有。

update_time

Long

作业更新时间。“show_detail”“false”时独有。

queue_name

String

队列名称。

edge_group_ids

Array of Strings

边缘计算组ID列表。多个ID以逗号分隔。

restart_times

Integer

重启次数。

savepoint_path

String

手动产生的Checkpoint的保存路径。

表6 job_config参数说明

参数名称

是否必选

参数类型

说明

checkpoint_enabled

Boolean

是否开启作业自动快照功能。

  • true:开启
  • false:关闭

默认为“false”

checkpoint_mode

String

快照模式,。两种可选:

  • exactly_once:数据只被消费一次。
  • at_least_once:数据至少被消费一次。

默认值为“exactly_once”

checkpoint_interval

Integer

快照时间间隔。 单位为秒,默认值为“10”

log_enabled

Boolean

是否启用日志存储。默认为“false”

obs_bucket

String

OBS桶名。

smn_topic

String

SMN主题名。当作业异常时,向该SMN主题推送告警信息。

root_id

Integer

父作业ID。

edge_group_ids

Array of Strings

边缘计算组ID列表。多个ID以逗号分隔。

manager_cu_number

Integer

管理单元CU数。默认为“1”

cu_number

Integer

用户为作业选择的CU数量。 “show_detail”“true”时独有。

  • 最小值:2
  • 最大值:400

默认为“2”

parallel_number

Integer

用户设置的作业并行数。 “show_detail”“true”时独有。

  • 最小值:1
  • 最大值:2000

默认为“1”

restart_when_exception

Boolean

是否开启异常重启功能。

idle_state_retention

Integer

空闲状态过期周期。

udf_jar_url

String

用户已上传到DLI资源管理系统的程序包名,用户sql作业的udf jar通过该参数传入。

dirty_data_strategy

String

作业脏数据策略。

  • “2:obsDir”:保存,obsDir表示脏数据存储路径。
  • “1”:抛出异常。
  • “0”:忽略。

entrypoint

String

用户已上传到DLI资源管理系统的程序包名,用户自定义作业主类所在的jar包。

dependency_jars

Array of Strings

用户已上传到DLI资源管理系统的程序包名,用户自定义作业的其他依赖包。

dependency_files

Array of Strings

用户已上传到DLI资源管理系统的资源包名,用户自定义作业的依赖文件。

executor_number

Integer

作业使用计算节点个数。

executor_cu_number

Integer

计算节点cu数。

resume_checkpoint

Boolean

异常自动重启时,是否从最新checkpoint恢复。默认值为“false”。

runtime_config

String

Flink作业运行时自定义优化参数。

graph_editor_enabled

Boolean

流图编辑开关。默认为“false”。

graph_editor_data

String

流图编辑数据。默认为null。

resume_max_num

Integer

异常重试最大次数。-1代表无限。

checkpoint_path

String

检查点保存路径。

config_url

String

用户上传的config包OBS路径。

tm_cus

int

单TM所占CU数。

tm_slot_num

int

单TM Slot数。

image

String

自定义镜像。格式为:组织名/镜像名:镜像版本。

当用户设置“feature”“custom”时,该参数生效。用户可通过与“feature”参数配合使用,指定作业运行使用自定义的Flink镜像。关于如何使用自定义镜像,请参考《数据湖探索用户指南》。

feature

String

自定义作业特性。表示用户作业使用的Flink镜像类型。

  • basic:表示使用DLI提供的基础Flink镜像。
  • custom:表示使用用户自定义的Flink镜像。

flink_version

String

Flink版本。当用户设置“feature”“basic”时,该参数生效。用户可通过与“feature”参数配合使用,指定作业运行使用的DLI基础Flink镜像的版本。

operator_config

String

各算子并行度参数,以json的形式展示各算子id和并行度。

static_estimator_config

String

静态流图资源预估参数,以json的形式展示。

real_cu_number

Integer

实际使用的CU数。默认值为“0”,表示此时以“cu_number”的值为准。

请求示例

响应示例

{
    "is_success": "true",
    "message": "作业列表查询成功",
    "job_list": {
        "total_count": 26,
        "jobs": [
            {
                "job_id": 146,
                "name": "aaaaa",
                "desc": "",
                "user_name": "",
                "job_type": "flink_sql_job",
                "status": "job_init",
                "status_desc": "",
                "create_time": 1578892414688,
                "duration": 0,
                "root_id": -1,
                "graph_editor_enabled": false,
                "has_savepoint": false
            }
        ]
    }
}

状态码

状态码如表7所示。

表7 状态码

状态码

描述

200

查询作业列表成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容