# 查询补数据实例 - ShowFactorySupplementData #### 功能介绍 查询补数据实例列表，支持分页查询。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/doc?api=ShowFactorySupplementData)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI - URI格式 GET /v2/{project_id}/factory/supplement-data - 参数说明 表1URI参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目编号，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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位时间戳。 | #### 请求参数 表3请求Header参数 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | workspace | 否 | String | 工作空间id。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 - 如果不设置该参数，默认查询default工作空间下的数据。 - 如果需要查询其他工作空间的数据，需要带上该消息头。 说明： - 多个DataArts Studio实例需要指定工作空间。 - 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。 | | X-Auth-Token | 是 | String | IAM Token 最小长度：**0** 最大长度：**4096** | #### 响应参数 表4参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | total | 是 | Integer | 作业数量。 | | success | 是 | Boolean | true或者false。 | | msg | 是 | String | success。 | | rows | 是 | List\ | 包含若干补数据实例信息，参考[表5]。 | 表5row数据结构说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | job_list | 是 | List\ | 补数据作业名称，可能有依赖的作业，故会有多个作业的情况。 | | 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 | 实例状态： - SUCCESS：成功 - RUNNING ：运行中 - CANCEL：取消 | | submitted_date | 是 | Long | 作业创建时间。 | | supplement_data_run_time | 否 | [supplement_data_run_time] object | 补数据时间段，当前仅支持每天，如果没有补数据时间，则默认为"00:00-00:00"，参考[表6]。 | | supplement_data_instance_time | 否 | [supplement_data_instance_time] object | 支持补离散时间任务，参考[表7]。 | 表6SupplementDataRunTime参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | time_of_day | 是 | String | 每天的可补数据时间段，如：每天的10点15分到23点30分，表示：10:15-23:30。 | | day_of_week | 否 | String | 每周的星期几可以补数据，如：每周一，周三的每天10点15分到23点30分。 | | day_of_month | 否 | String | 每个月的哪几天可以补数据，如每月1号，3号，表示：1,3。 | 表7SupplementDataInstanceTime参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | days | 否 | array\[string\] | 支持离散的天。 | | time_of_day | 否 | String | 指定天中的时间段。 | #### 请求示例 查询作业列表。 ``` 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 } ``` - 失败响应 HTTP状态码 400 ``` { "error_code":"DLF.3051", "error_msg":"The request parameter is invalid." } ```