GetApplicationInstance - 查询作业实例--流式计算 Flink版-火山引擎

文档中心

流式计算 Flink版

GWS

GetApplicationInstance - 查询作业实例

查询指定作业实例信息

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string %%require%% 示例值：GetApplicationInstance
要执行的操作，取值：GetApplicationInstance。

Version string %%require%% 示例值：2025-01-01
API的版本，取值：2025-01-01。

InstanceId string %%require%% 示例值：1840646077740994561
实例ID

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Conf string 示例值：{\n \"kubernetes.jobmanager.cpu\":\"1\",\n \"jobmanager.memory.process.size\":\"4096mb\",\n \"kubernetes.taskmanager.cpu\":\"1\",\n \"taskmanager.memory.process.size\":\"4096mb\",\n \"taskmanager.numberOfTaskSlots\":\"2\",\n \"restart-strategy\": \"aggregated-failure-rate\",\n \"restart-strategy.aggregated-failure-rate.failure-rate-interval\": \"600second\",\n \"restart-strategy.aggregated-failure-rate.delay\": \"20second\",\n \"restart-strategy.aggregated-failure-rate.max-failures-per-interval\": \"20\",\n \"execution.checkpointing.interval\":\"180s\",\n \"execution.checkpointing.timeout\":\"600s\",\n \"parallelism.default\":\"2\"}
作业配置，json string

Core integer 示例值：1
核数

Cluster string 示例值：sdfdfads
集群

JobEngineKey string 示例值：sdfasd
job engine key

Duration integer 示例值：5
duration

CurrentEmitEventTimeLag integer 示例值：7
延迟lag

CurQueue string 示例值：o-xxsdfg
当前queue

ResourcePreemptionPolicy string 示例值：test
资源策略

Memory long 示例值：4
内存

ResourceVersion string 示例值：2
资源版本

RestUrl string 示例值：http://test
url

VersionId long 示例值：5
版本id

ApplicationId string 示例值：s-1840646077740994561
作业的 application id（同个作业的实例多次启停该值会变化）对应 k8s 的 application_id

Args string 示例值：--topic pyjstorm-test-1 --bootstrap.servers kafka-cnnxxm5tg2otd0.kafka.ivolces.com:9092
datastream main args (针对 Jar作业)

AccountId string 示例值：2101007020
火山租户 accountId

Id string 示例值：1840646077740994561
作业实例 Id

JobType string 示例值：FLINK_STREAMING_SQL
作业类型

JobName string 示例值：sql_test_16
作业名

JobId string 示例值：1840646077740994562
作业实例所属 AppId

Jar string 示例值：tos://mt-gts//gls/lib/flink.jar
datastream 主 jar（建议使用 tos地址） (针对 Jar作业)

EngineVersion string 示例值：FLINK_VERSION_1_16
引擎版本

EndTime string 示例值：2024-09-30 15:53:17
作业实例停止时间

DeploymentId string 示例值：0389aeb7e5d64220ac5b6e9b78ed7c1b
任务在k8s环境的deployment id（同一个作业的实例多次启停该值不变）

DeployRequest object 示例值：{ "Queue": "o-0080kuwxxx", "Priority": "3", "ResourcePool": "rs-pool-a", "SchedulePolicy": "GANG", "ScheduleTimeout": "60" }
部署策略(见公共结构2.1.4)

ResourcePool string 示例值：test-resource-pool
资源池名称

Namespace string 示例值：o-0080sv6hfmn6
项目在k8s环境部署的namespace

Queue string 示例值："o-00g0ouqtg9n7"
资源池唯一标识, 非资源池名称

ScheduleTimeout string 示例值：60
调度超时时间，单位秒级；推荐 60s

SchedulePolicy string 示例值：GANG
Job调度策略，支持 "GANG" 和 "DRF" 两种策略；使用GANG调度策略，保证一个作业的所有实例一起被调度，使用 DRF 算法，公平地将资源分配给资源池内的各个作业。

Priority string
优先级，从"1" ...到 "5"，数字越高优先级越低；

Dependency object 示例值：{ "Jars": ["tos://a.jar","tos://b.jar"] }
外部依赖

Jars string[] 示例值：["tos://a.jar", "tos://b.jar"]
支持Jar ID或者是 Jar文件的具体路径，用于Flink

PyLibraries string[]
python依赖，pyflink 使用

CompleteRestUrl string 示例值：http://6fafc4ed51ad433ca6a90629d6a901de-ingress.openstudio.ivolces.com:80/login-server/ui/t34be7bfc91e14ac8a02650b3b45172f0-rest.o-00g0kdtxl0e4:8081/
flink 完整的 url 路径

MainClass string 示例值：com.bytedance.openplatform.flink.DatagenToPrint
datastream 主类 (针对 Jar作业)

ProjectId string 示例值：cja21wx8gr9q
项目id

SqlText string 示例值：create table orders (\n f0 varchar\n) WITH (\n 'connector' = 'datagen'\n);\n\ninsert into hive.flink.t1\nselect * from orders;
sql作业的 sqlText (针对SQL)

StartTime string 示例值：2024-09-30 14:53:17
作业实例启动时间

State string 示例值：RUNNING
作业实例状态

UserId string 示例值：f75c80a288084c91b22b04c25e36a2c8
flink 内部userId

请求示例

POST /?Action=GetApplicationInstance&Version=2025-01-01&ProjectId=cja21wx8gr9q HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241028T080739Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241028/cn-beijing/flink/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "InstanceId": "1840646077740994561"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241028160746227112206173C56A5C",
    "Action": "GetApplicationInstance",
    "Version": "2025-01-01",
    "Service": "flink",
    "Region": "cn-beijing"
  },
  "Result": {
    "ApplicationId": "s-1840646077740994561",
    "Args": "--topic pyjstorm-test-1 --bootstrap.servers kafka-cnnxxm5tg2otd0.kafka.ivolces.com:9092",
    "AccountId": "2101007020",
    "Id": "1840646077740994561",
    "JobType": "FLINK_STREAMING_SQL",
    "JobName": "sql_test_16",
    "JobId": "1840646077740994562",
    "Jar": "tos://mt-gts//gls/lib/flink.jar",
    "EngineVersion": "FLINK_VERSION_1_16",
    "EndTime": "2024-09-30 15:53:17",
    "DeploymentId": "0389aeb7e5d64220ac5b6e9b78ed7c1b",
    "DeployRequest": {
      "Priority": 5,
      "ResourcePool": "test-resource-pool",
      "SchedulePolicy": "GANG",
      "ScheduleTimeout": "60",
      "Namespace": "o-0080sv6hfmn6",
      "Queue": "\"o-00g0ouqtg9n7\""
    },
    "Dependency": {
      "Jars": [
        "[\"tos://a.jar\", \"tos://b.jar\"]"
      ],
      "PyLibraries": [
        "Qo"
      ]
    },
    "Conf": {},
    "CompleteRestUrl": "http://6fafc4ed51ad433ca6a90629d6a901de-ingress.openstudio.ivolces.com:80/login-server/ui/t34be7bfc91e14ac8a02650b3b45172f0-rest.o-00g0kdtxl0e4:8081/",
    "MainClass": "com.bytedance.openplatform.flink.DatagenToPrint",
    "ProjectId": "cja21wx8gr9q",
    "SqlText": "create table orders (\\n f0 varchar\\n) WITH (\\n 'connector' = 'datagen'\\n);\\n\\ninsert into hive.flink.t1\\nselect * from orders;",
    "StartTime": "2024-09-30 14:53:17",
    "State": "RUNNING",
    "UserId": "f75c80a288084c91b22b04c25e36a2c8"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	default system error	can't get instance with id xxx	获取 instance 实例失败，具体失败原因参照 error message

最近更新时间：2026.05.18 11:09:18

这个页面对您有帮助吗？

有用

无用

流式计算 Flink版

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码