查询补数据实例 - ShowFactorySupplementData
功能介绍
查询补数据实例列表,支持分页查询。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
- 参数说明
表1 URI参数说明 参数名
是否必选
参数类型
说明
project_id
是
String
项目编号,获取方法请参见项目ID和账号ID。
表2 Query参数 参数
是否必选
参数类型
描述
sort
否
String
排序字段:
- desc:创建时间按照降序展示
- asc :创建时间按照升序展示
默认值:desc
page
否
Integer
分页列表的起始页,默认值为0。取值范围大于等于0。
size
否
Integer
分页返回结果,指定每页最大记录数。默认值:10。
name
否
String
补数据实例名称
user_name
否
String
用户名
status
否
String
实例状态:
- SUCCESS:成功
- RUNNING :运行中
- CANCEL:取消
start_date
否
Long
查询作业的开始日期,13位时间戳。
end_date
否
Long
查询作业的结束日期,13位时间戳。
请求参数
参数名 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
workspace | 否 | String | 工作空间id。
|
X-Auth-Token | 是 | String | IAM Token 最小长度:0 最大长度:4096 |
响应参数
参数名 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
total | 是 | Integer | 作业数量。 |
success | 是 | Boolean | true或者false。 |
msg | 是 | String | success。 |
rows | 是 | List<row> | 包含若干补数据实例信息,参考表5。 |
参数名 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
job_list | 是 | List<String> | 补数据作业名称,可能有依赖的作业,故会有多个作业的情况。 |
name | 是 | String | 补数据实例名称。 |
user_name | 是 | String | 用户名称。 |
type | 是 | int | 触发补数据的类型,取值范围[0, 1]。0代表作业监控界面触发的补数据,1代表恢复动作触发的补数据。 |
start_date | 是 | Long | 作业的开始日期,13位时间戳。 |
end_date | 是 | Long | 作业的结束日期,13位时间戳。 |
parallel | 是 | int | 补数据实例的并行周期数,取值范围[1,5]。 |
status | 是 | String | 实例状态:
|
submitted_date | 是 | Long | 作业创建时间。 |
supplement_data_run_time | 否 | supplement_data_run_time object | 补数据时间段,当前仅支持每天,如果没有补数据时间,则默认为"00:00-00:00”,参考表6。 |
supplement_data_instance_time | 否 | 支持补离散时间任务,参考表7。 |
请求示例
查询作业列表。
GET /v2/62099355b894428e8916573ae635f1f9/factory/supplement-data
响应示例
- 成功响应 HTTP状态码200
{ "msg": "success", "rows": [ { "end_date": 1692633599000, "job_list": [ "job_8810", "job_1000" ], "name": "P_job_8810_20230821_175711", "parallel": 1, "start_date": 1692547200000, "status": "RUNNING", "submitted_date": 1692611566436, "supplement_data_run_time": { "time_of_day": "00:00-00:00" }, "supplement_data_instance_time": {}, "type": 0, "user_name": "user_test" } ], "success": true, "total": 1 } - 失败响应
{ "error_code":"DLF.3051", "error_msg":"The request parameter is invalid." }

