您可以使用flink rest api的方式来调用本接口,获取session集群或者运行作业的相关信息。注意本接口仅支持您获取相关信息,无法对session集群和作业进行操作或管理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
stream:FlinkApiProxy | none |
|
| 无 |
请求语法
GET /flink-ui/v2/proxy HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
workspace | string | 是 | 工作空间 ID。 | a14bd5d90a**** |
namespace | string | 是 | 项目空间名称。 | default-namespace |
resourceType | string | 是 | 资源类型,支持以下类型:
| jobs |
resourceId | string | 是 | 资源类型是 jobs,则使用 jobid;资源类型是 sessionclusters,则使用 session 名称。 | 5a27a3aa-c5b9-4dc1-8c86-be57d2d6**** |
flinkApiPath | string | 是 | flink rest api 路径。如/jobs/:jobid/config 可以获取 jobid 对应作业的配置信息,更多使用可查看flink 社区 rest api 文档。 | /jobs/:4df35f8e54554b23bf7dcd38a151****/config |
返回参数
示例
正常返回示例
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 } } ] }"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史