查看所有SQL模板 - ListSqlJobTemplates
功能介绍
该接口用于查看用户保存的所有SQL模板。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限及授权项说明。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
Action
访问级别
Access Level
资源类型(*为必须)
Resource Type (*: required)
条件键
Condition Key
别名
Alias
依赖的授权项
Dependencies
dli:template:list
list
template *
-
-
-
URI
- URI格式:
- 参数说明
表1 URI参数说明 参数
是否必选
参数类型
描述
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
表2 query参数 参数名称
是否必选
参数类型
说明
keyword
否
String
用于过滤SQL模板的关键字。
请求参数
无
响应参数
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
is_success |
Boolean |
是否成功。 |
|
message |
String |
系统提示信息,执行成功时,信息可能为空。执行失败时,用于显示执行失败的原因。 |
|
sql_count |
Int |
SQL模板总数。 |
|
sqls |
Array of Object |
SQL模板信息,具体参数说明请参见表4。 |
请求示例
无
响应示例
{
"is_success": true,
"message": "",
"sql_count": 1,
"sqls": [
{
"description": "use to select t1",
"owner": "tenant1",
"sql": "select * from t1",
"sql_id": "1994b029-3f76-4281-9e35-e370cb4ee26d1501998934432",
"sql_name": "sql1",
"group": ""
}
]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。