Querying PatchData Instances

Function

This API is used to query PatchData instances. Pagination query is supported.

URI

• URI format

  GET /v2/{project_id}/factory/supplement-data?sort={sort}&page={page}&size={size}&name={name}&user_name={user_name}&status={status}&start_date={start_date}&end_date={end_date}

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
  name	No	String	PatchData name
  user_name	No	String	Username
  status	No	String	Instance status SUCCESS: The job is successful. RUNNING: The job is running. CANCLE: The job has been canceled.
  sort	No	String	Sorting field desc: The results are displayed in descending order of creation time. asc: The results are displayed in ascending order of creation time. The default value is desc.
  page	No	Integer	Start page of the paging list. Default value: 0 The value must be greater than or equal to 0.
  size	No	Integer	The maximum number of records on each page. Default value: 10
  start_date	No	Long	13-digit timestamp of the start date of the query job
  end_date	No	Long	13-digit timestamp of the end date of the query job

Request Parameters

Response Parameters

Example Request

Query the job list.

GET /v2/62099355b894428e8916573ae635f1f9/factory/supplement-data

Example Response

• Success response: HTTP status code 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
  }

• Failure response

  HTTP status code 400

  {
      "error_code":"DLF.3051",
      "error_msg":"The request parameter is invalid."
  }