更新时间:2022-04-16 GMT+08:00
分享

查询模板列表

功能介绍

该API查询作业模板列表。当前只支持查询用户自定义模板。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v1.0/{project_id}/streaming/job-templates

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    表2 query参数说明

    参数名称

    是否必选

    参数类型

    描述

    name

    String

    模板名称。支持根据name进行模糊查询。

    tags

    String

    标签名列表。单个标签为k=v,多个标签以“,”分隔。示例tag1=v1,tag2=v2。

    offset

    Long

    作业偏移量。

    limit

    Integer

    返回的数据条数。默认为“10”

    order

    String

    查询结果排序。

    • asc:升序
    • desc:降序

    默认为“desc”

请求消息

无请求参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

请求是否成功。

message

String

消息内容。

template_list

Object

模板列表信息。请参见表4

表4 template_list参数说明

参数名称

是否必选

参数类型

说明

total_count

Integer

模板总数。

templates

Array of Objects

模板详细信息。具体参数说明详见表5

表5 templates参数说明

参数名称

是否必选

参数类型

说明

template_id

Integer

模板ID。

name

String

模板名称。

desc

String

模板描述。

create_time

Long

模板创建时间。

update_time

Long

模板更新时间。

sql_body

String

Stream SQL语句。至少包含source、 query、sink三个部分。

job_type

String

作业模板类型。

示例

  • 请求样例
    None
  • 响应样例
    {
        "is_success": "true",
        "message": "获取模板列表成功",
        "template_list": {
            "total_count": 2,
            "templates": [
                {
                    "template_id": 2,
                    "name": "updatetest",
                    "desc": "快速上手示例",
                    "create_time": 1578748092000,
                    "update_time": 1578748092000,
                    "sql_body": "select * from source_table",
                    "job_type": "flink_sql_job"
                },
                {
                    "template_id": 1,
                    "name": "we",
                    "desc": "qwe",
                    "create_time": 1577951045000,
                    "update_time": 1577951045000,
                    "sql_body": ""
                }
            ]
        }
    }

状态码

状态码如表6所示。

表6 状态码

状态码

描述

200

查询模板列表成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close