Query Instance Task Details

Function

This API is used to query the task details of an IoTDA instance.

URI

GET /v5/iot/{project_id}/iotda-instances/{instance_id}/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description : project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Parameter description: instance ID. Value: Enter up to 36 characters, including lowercase letters (a to f), digits, and hyphens (-).
task_id	Yes	String	Parameter description: instance task ID. Value: Enter up to 64 characters, including lowercase letters (a to f), digits, and hyphens (-).

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
task_id	String	Parameter description: instance task ID. Value: Enter up to 64 characters, including lowercase letters (a to f), digits, and hyphens (-).
type	String	Parameter description: instance task type. Range: CREATE: instance creation task MODIFY: task for changing instance specifications DELETE: instance deletion task FREEZE: instance freezing task UNFREEZE: instance unfreezing task UPDATE_ACCESS_CONFIG: task for modifying instance access information UPDATE_ALLOW_LISTS: task for modifying the instance access whitelist OPEN_SNAT: task for enabling SNAT configuration of an instance
status	String	Parameter description: task status. Range: PENDING: The task is waiting to be executed. RUNNING: The task is being executed. SUCCESS: The task is executed successfully. FAILED: The task fails to be executed.
status_detail	String	Parameter description: task status description.
create_time	String	Parameter description: time when the instance task is created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
start_time	String	Parameter description: time when the instance task starts. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
end_time	String	Parameter description: time when the instance task ends. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
target_config	TargetConfig object	The target specification of the instance.
operate_window	OperateWindow object	Instance maintenance time window. You can specify the time window during which the specifications are modified.
progress	Integer	Parameter description: task progress.

**Table 3** TargetConfig
Parameter	Type	Description
flavor	Flavor object	Parameter description: specifications of an IoTDA instance.
charge_mode	String	Parameter description: payment mode of the instance. Range: postPaid: pay-per-use

**Table 4** Flavor
Parameter	Type	Description
type	String	Parameter description : specification name of the IoTDA instance to create. For details, see Specifications.
size	Integer	Parameter description : unit number of the standard IoTDA instances to create. For details, see Specifications.

**Table 5** OperateWindow
Parameter	Type	Description
start_time	String	Parameter description: start time of the change time window. The value is UTC time in HH:mm format.
end_time	String	Parameter description: end time of the change time window. The value is UTC time in HH:mm format.

Example Requests

Queries instance task details.

GET https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}/tasks/{task_id}

Example Responses

Status code: 200

{
  "task_id" : "075f413d-a3bb-4243-974d-8eb9221c1234",
  "type" : "MODIFY",
  "status" : "PENDING",
  "create_time" : "2021-08-19T01:52:49.493Z",
  "start_time" : "2021-08-19T01:52:49.492Z",
  "end_time" : "2021-08-19T01:52:49.492Z",
  "target_config" : {
    "flavor" : {
      "type" : "iotda.enterprise.1000tps.10wonlinedevice",
      "size" : null
    }
  },
  "operate_window" : {
    "start_time" : "18:00",
    "end_time" : "22:00"
  },
  "progress" : 80
}