调用FlinkApiProxy完成对flink请求的代理。

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

名称 类型 是否必选 示例 描述
workspace String 是 a14bd5d90a****

工作空间ID。

请求语法

GET /flink-ui/v2/proxy HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
namespace String Query 是 default-namespace

项目空间名称。
resourceType String Query 是 jobs

资源类型，支持以下类型：

  • jobs

  • sessionclusters
resourceId String Query 是 5a27a3aa-c5b9-4dc1-8c86-be57d2d6****

资源ID。
flinkApiPath String Query 是 /jobs/4df35f8e54554b23bf7dcd38a151****

flink-ui路径。

返回数据

名称 类型 示例值 描述
requestId String CBC799F0-AS7S-1D30-8A4F-882ED4DD****

请求ID。
httpCode Integer 200

固定值200。
success Boolean true

表示业务请求是否成功。
errorCode String ""
  • 当success为false，返回业务错误码；
  • 当success为true，返回空值。
errorMessage String ""
  • 当success为false，返回业务错误信息；
  • 当success为true，返回空值。
data String { "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 } } ] }
  • 当success为true，返回代理请求结果；
  • 当success为false，返回空值。

示例

请求示例

GET /flink-ui/v2/proxy?namespace=default-namespace&resourceType=jobs&resourceId=5a27a3aa-c5b9-4dc1-8c86-be57d2d6****&flinkApiPath=/jobs/4df35f8e54554b23bf7dcd38a151**** HTTP/1.1
Host:ververica.aliyuncs.com
workspace:a14bd5d90a****
Content-Type:application/json

正常返回示例

XML格式 

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

<FlinkApiProxyResponse>
    <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>
    <httpCode>200</httpCode>
    <success>true</success>
    <errorCode>""</errorCode>
    <errorMessage>""</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 } } ] }</data>
</FlinkApiProxyResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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 } } ] }"
}