FlinkApiProxy_实时计算 Flink版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
stream:FlinkApiProxy
None
全部资源
*

请求语法

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

请求参数

字段名称字段详情
workspacestring

工作空间 ID。

示例值:a14bd5d90a****
namespacestring

项目空间名称。

示例值:default-namespace
resourceTypestring

资源类型,支持以下类型:展开详情

示例值:jobs
resourceIdstring

资源类型是 jobs,则使用 jobid;资源类型是 sessionclusters,则使用 session 名称。

示例值:5a27a3aa-c5b9-4dc1-8c86-be57d2d6****
flinkApiPathstring

flink rest api 路径。如/jobs/jobid/config 可以获取 jobid 对应作业的配置信息,更多使用可查看flink 社区 rest api 文档

示例值:/jobs/:4df35f8e54554b23bf7dcd38a151****/config

返回参数

字段名称字段详情
requestIdstring

请求 ID。

示例值:CBC799F0-AS7S-1D30-8A4F-882ED4DD****
httpCodeinteger<int32>

固定值 200。

示例值:200
successboolean

表示业务请求是否成功。

示例值:true
errorCodestring
  • 当 success 为 false,返回业务错误码;展开详情
示例值:""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;展开详情
示例值:""
datastring
  • 当 success 为 true,返回代理请求结果;展开详情
示例值:{ "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 } } ] }

返回示例

变更历史

暂无变更历史

相关示例