查询模板列表 - ListFlinkSqlJobTemplates

功能介绍

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

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

• 如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。
• 如果使用身份策略授权，需具备如下身份策略权限。

  授权项 Action	访问级别 Access Level	资源类型（*为必须） Resource Type (*: required)	条件键 Condition Key	别名 Alias	依赖的授权项 Dependencies
  dli:template:list	list	template *	-	-	-

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”。

请求消息

无请求参数。

响应消息

请求示例

无

响应示例

{
    "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所示。

错误码

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