Function

This API is used to query dump task details.

When querying dump task details, you need to specify the stream name and dump task name.

URI

• URI format

  GET /v2/{project_id}/streams/{stream_name}/transfer-tasks/{transfer_task_name}

• Parameter description

  None

Request

• Example request

  GET https://{endpoint}/v2/{project_id}/streams/stream_test/transfer-tasks/task_test

• Parameter description

  Parameter	Mandatory	Type	Description
  stream_name	Yes	String	Name of the DIS stream to be queried.
  transfer_task_name	Yes	String	Name of the dump task.

Response

• Example response

  {
      "partitions":[
          {
              "partitionId":"shardId-0000000000",
              "discard":0,
              "state":"RUNNING",
              "last_transfer_timestamp":1534163694103,
              "last_transfer_offset":2139
          }
      ],
      "destination_type": "OBS",
      "stream_name":"feihang",
      "task_name":"feihang",
      "state":"RUNNING",
      "create_time":1534142793097,
      "last_transfer_timestamp":1534163694103,
      "obs_destination_description":{
          "agency_name":"a",
          "file_prefix":"feihang",
          "partition_format":"",
          "obs_bucket_path":"0feihang",
          "deliver_time_interval":30,
          "consumer_strategy":"LATEST",
          "destination_file_type":"text"
      }
  }

• Parameter description

  Table 1 Response parameter description

  Parameter	Type	Description
  stream_name	String	Name of the DIS stream.
  task_name	String	Name of the dump task.
  create_time	Long	Task creation timestamp.
  last_transfer_timestamp	Long	Timestamp of the latest dump.
  state	String	Dump task status. Possible values: ABNORMAL RUNNING
  destination_type	String	Dump destination. Possible values: OBS MRS DLI CLOUDTABLE DWS
  partitions	List<PartitionTask>	List of partition dump details.
  obs_destination_description	Object	Parameter list of the OBS to which data in the DIS stream will be dumped. Data in a DIS stream cannot be dumped to multiple destinations. This parameter is left unspecified by default. If this parameter is left unspecified, data is not dumped to OBS.
  mrs_destination_description	Object	Parameter list of the MRS to which data in the DIS stream will be dumped. Data in a DIS stream cannot be dumped to multiple destinations. This parameter is left unspecified by default. If this parameter is left unspecified, data is not dumped to MRS.
  dli_destination_description	Object	Parameter list of the DLI to which data in the DIS stream will be dumped. Data in a DIS stream cannot be dumped to multiple destinations. This parameter is left unspecified by default. If this parameter is left unspecified, data is not dumped to DLI.
  cloudtable_destination_descripton	Object	Parameter list of the CloudTable to which data in the DIS stream will be dumped. Data in a DIS stream cannot be dumped to multiple destinations. This parameter is left unspecified by default. If this parameter is left unspecified, data is not dumped to CloudTable HBase or OpenTSDB.
  dws_destination_descripton	Object	Parameter list of the DWS to which data in the DIS stream will be dumped. Data in a DIS stream cannot be dumped to multiple destinations. This parameter is left unspecified by default. If this parameter is left unspecified, data is not dumped to DWS.

  Table 2 PartitionTask parameter description

  Parameter	Type	Description
  partitionId	String	Unique identifier of the partition.
  discard	Integer	Total number of dirty data records in the current partition.
  state	String	Dump task status. Possible values: ABNORMAL RUNNING
  last_transfer_timestamp	Long	Timestamp of the latest dump.
  last_transfer_offset	Long	Offset of the latest dump.

Response Code

• Normal

  200 OK

• Failed

  For more information, see Error Codes.