调用ListJobs接口获取任务模板列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
sae:ListJobs |
|
| 无 |
请求语法
GET /pop/v1/sam/job/listJobs HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CurrentPage | integer | 否 | 当前页数。取值从 1 开始。 | 1 |
PageSize | integer | 否 | 页面大小。取值范围为[0,200]。 | 20 |
AppName | string | 否 | 任务模板名称。 | demo-app |
NamespaceId | string | 否 | 命名空间 ID。 | cn-beijing:demo |
Tags | string | 否 | 标签列表,JSON 字符串。取值说明如下:
| [{"key":"key","value":"value"}] |
OrderBy | string | 否 | 对任务模板进行排序。取值说明如下:
| running |
Reverse | boolean | 否 | 根据 OrderBy 参数传入的字段名排序。取值说明如下:
| true |
FieldType | string | 否 | 设置筛选任务模板的维度。取值说明如下:
| appName |
FieldValue | string | 否 | 根据已设置的 FieldType 筛选维度,选择输入目标任务模板的任务模板名称或任务模板 ID。 | demo-app |
Workload | string | 否 | Workload 需指定为 | job |
返回参数
示例
正常返回示例
JSON
格式
{
"Message": "success",
"RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
"Data": {
"CurrentPage": 1,
"TotalSize": 2,
"PageSize": 20,
"Applications": [
{
"AppName": "demo-app",
"NamespaceId": "cn-beijing:demo",
"AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
"Tags": [
{
"Key": "key",
"Value": "value"
}
],
"RegionId": "cn-beijing",
"AppDescription": "description",
"TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
"Suspend": false,
"Active": 0,
"Succeeded": 3,
"Failed": 0,
"LastStartTime": 1657522800,
"CompletionTime": 1657522839,
"LastChangeorderState": "1",
"LastJobState": "0",
"Cpu": 500,
"Mem": 1024,
"Message": "success"
}
]
},
"ErrorCode": "空",
"Code": "200",
"Success": true,
"CurrentPage": 1,
"TotalSize": 2,
"PageSize": 20
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidAppId.NotFound | The specified AppId does not exist. | 指定的AppId不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-30 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |