文档

FlinkApiProxy - Flink请求代理

更新时间:

代理Flink请求,获取请求结果。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /flink-ui/v2/proxy

请求参数

名称类型必填描述示例值
workspacestring

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
resourceTypestring

资源类型,支持以下类型:

  • jobs
  • sessionclusters
jobs
resourceIdstring

资源 ID。

5a27a3aa-c5b9-4dc1-8c86-be57d2d6****
flinkApiPathstring

flink-ui 路径。

/jobs/4df35f8e54554b23bf7dcd38a151****

返回参数

名称类型描述示例值
object

Flink 请求的返回值。

requestIdstring

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****
httpCodeinteger

固定值 200。

200
successboolean

表示业务请求是否成功。

true
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
datastring
  • 当 success 为 true,返回代理请求结果;

  • 当 success 为 false,返回空值。

{ "jobs": [ { "jid": "4df35f8e54554b23bf7dcd38a151****", "name": "69d001d5-419a-4bfc-9c2e-849cacd3****", "state": "RUNNING", "start-time": 1659154942068, "end-time": -1, "duration": 188161756, "last-modification": 1659154968305, "tasks": { "total": 2, "created": 0, "scheduled": 0, "deploying": 0, "running": 2, "finished": 0, "canceling": 0, "canceled": 0, "failed": 0, "reconciling": 0, "initializing": 0 } } ] }

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "httpCode": 200,
  "success": true,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": "{ \"jobs\": [ { \"jid\": \"4df35f8e54554b23bf7dcd38a151****\", \"name\": \"69d001d5-419a-4bfc-9c2e-849cacd3****\", \"state\": \"RUNNING\", \"start-time\": 1659154942068, \"end-time\": -1, \"duration\": 188161756, \"last-modification\": 1659154968305, \"tasks\": { \"total\": 2, \"created\": 0, \"scheduled\": 0, \"deploying\": 0, \"running\": 2, \"finished\": 0, \"canceling\": 0, \"canceled\": 0, \"failed\": 0, \"reconciling\": 0, \"initializing\": 0 } } ] }"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)