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

• Parameter description

  Table 1 URI parameter

  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.

  Table 2 Query parameters

  Parameter	Mandatory	Type	Description
  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. The default value is 0. The value must be greater than or equal to 0.
  size	No	Integer	Maximum number of records on each page. The default value is 10.
  name	No	String	PatchData instance name
  user_name	No	String	Username
  status	No	String	Instance status SUCCESS: The job is successful. RUNNING: The job is running. CANCEL: The job has been canceled.
  start_date	No	Long	Query start date, which is a 13-digit timestamp
  end_date	No	Long	Query end date, which is a 13-digit timestamp

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."
  }