调用ListFlowJobs接口查询作业列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFlowJobs

系统规定参数。取值:ListFlowJobs

RegionId String cn-hangzhou

地域ID。

ProjectId String FP-3535FE0BE5228***

项目ID。您可以调用ListFlowProjects查看项目的ID。

Id String FJ-1A2FB31D8295****

作业ID。您可以调用ListFlowJobs查看作业ID。

Name String my_job_name

作业名称。

Type String SPARK

作业类型。用于过滤作业,支持的类型有:SPARK,SPARK_STREAMING,ZEPPELIN。

Adhoc Boolean true

是否为临时查询。用于过滤作业。

PageNumber Integer 1

当前页数。

PageSize Integer 20

每页的作业数量。

ExactName String my_job_name

精确匹配 job name

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

当前页数。

PageSize Integer 20

每页的作业数量。

RequestId String 1549175a-6d14-4c8a-89f9-5e28300f6d7e

请求ID。

Total Integer 3

作业数量。

JobList Array of Job

作业列表。

Job
Type String SPARK

作业的类型,可能的取值有:SPARK,SPARK_STREAMING,ZEPPELIN

FailAct String STOP

失败策略,可能的取值:CONTINUE(提过本次作业),STOP(停止作业)

CustomVariables String {"scope": "project"}

自定义变量。

RetryInterval Long 200

重试间隔 0~300(秒)。

EnvConf String {"key":"value"}

环境变量设置。

ParamConf String {"date":"${yyyy-MM-dd}"}

参数设置。

Mode String YARN

模型模式,取值如下: YARN:将作业包装成一个Launcher提交至YARN中执行,LOCAL:作业直接在机器上以进程方式运行。

GmtModified Long 1538017813000

最后修改时间。

MonitorConf String {"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}

监控配置,仅SPARK_STREAMING类型作业支持监控配置。

LastInstanceDetail String FJI-0BA97D0BB8F3****

最后一次执行的实例ID。

RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

运行配置,取值如下:priority(优先级),userName(任务的Linux提交用户),memory(内存,单位为MB),cores(核数)

Params String oss://bucket_name/jar_to_run.jar

作业内容。

Description String 这是一个作业描述。

作业的描述。

GmtCreate Long 1538017814000

创建时间。

CategoryId String FC-5BD9575E3462****

作业所在目录ID。

Adhoc String false

是否临时查询。

Name String Job_name_example

作业名称。

Id String FJ-BCCAE48B90CC****

作业ID。

MaxRetry Integer 3

最大重试次数。

AlertConf String

报警配置。

ResourceList Array of Resource

资源列表。

Resource
Path String

保留参数。

Alias String

保留参数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlowJobs
&RegionId=cn-hangzhou
&ProjectId=FP-3535FE0BE5228***
&Id=FJ-1A2FB31D8295****
&Name=my_job_name
&Type=SPARK
&Adhoc=true
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFlowJobsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <RequestId>1549175a-6d14-4c8a-89f9-5e28300f6d7e</RequestId>
    <Total>3</Total>
    <JobList>
        <Type>SPARK</Type>
        <FailAct>STOP</FailAct>
        <CustomVariables>{"scope": "project"}</CustomVariables>
        <RetryInterval>200</RetryInterval>
        <EnvConf>{"key":"value"}</EnvConf>
        <ParamConf>{"date":"${yyyy-MM-dd}"}</ParamConf>
        <Mode>YARN</Mode>
        <GmtModified>1538017813000</GmtModified>
        <MonitorConf>{"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}</MonitorConf>
        <LastInstanceDetail>FJI-0BA97D0BB8F3****</LastInstanceDetail>
        <RunConf>{"priority":1,"userName":"hadoop","memory":2048,"cores":1}</RunConf>
        <Params>oss://bucket_name/jar_to_run.jar</Params>
        <Description>这是一个作业描述。</Description>
        <GmtCreate>1538017814000</GmtCreate>
        <CategoryId>FC-5BD9575E3462****</CategoryId>
        <Adhoc>false</Adhoc>
        <Name>Job_name_example</Name>
        <Id>FJ-BCCAE48B90CC****</Id>
        <MaxRetry>3</MaxRetry>
        <AlertConf>无</AlertConf>
        <ResourceList>
            <Path>无</Path>
            <Alias>无</Alias>
        </ResourceList>
    </JobList>
</ListFlowJobsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "PageSize" : 20,
  "RequestId" : "1549175a-6d14-4c8a-89f9-5e28300f6d7e",
  "Total" : 3,
  "JobList" : [ {
    "Type" : "SPARK",
    "FailAct" : "STOP",
    "CustomVariables" : "{\"scope\": \"project\"}",
    "RetryInterval" : 200,
    "EnvConf" : "{\"key\":\"value\"}",
    "ParamConf" : "{\"date\":\"${yyyy-MM-dd}\"}",
    "Mode" : "YARN",
    "GmtModified" : 1538017813000,
    "MonitorConf" : "{\"inputs\":[{\"type\":\"KAFKA\",\"clusterId\":\"C-1234567\",\"topics\":\"kafka_topic\",\"consumer.group\":\"kafka_consumer_group\"}],\"outputs\":[{\"type\":\"KAFKA\",\"clusterId\":\"C-1234567\",\"topics\":\"kafka_topic\"}]}",
    "LastInstanceDetail" : "FJI-0BA97D0BB8F3****",
    "RunConf" : "{\"priority\":1,\"userName\":\"hadoop\",\"memory\":2048,\"cores\":1}",
    "Params" : "oss://bucket_name/jar_to_run.jar",
    "Description" : "这是一个作业描述。",
    "GmtCreate" : 1538017814000,
    "CategoryId" : "FC-5BD9575E3462****",
    "Adhoc" : "false",
    "Name" : "Job_name_example",
    "Id" : "FJ-BCCAE48B90CC****",
    "MaxRetry" : 3,
    "AlertConf" : "无",
    "ResourceList" : [ {
      "Path" : "无",
      "Alias" : "无"
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。