查询实例任务详情
功能介绍
用户可以调用此接口查询设备接入实例任务详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v5/iot/{project_id}/iotda-instances/{instance_id}/tasks/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数说明:项目ID。获取方法请参见 获取项目ID。 |
instance_id |
是 |
String |
参数说明:实例ID。 取值范围:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。 |
task_id |
是 |
String |
参数说明:实例任务Id。 取值范围:长度不超过64,由小写字母[a-f]、数字、连接符(-)的组成。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
参数说明:实例任务Id。 取值范围:长度不超过64,由小写字母[a-f]、数字、连接符(-)的组成。 |
type |
String |
参数说明:实例任务类型。 取值范围:
|
status |
String |
参数说明:任务状态。 取值范围:
|
status_detail |
String |
参数说明:任务状态描述。 |
create_time |
String |
参数说明:实例任务的创建时间。格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" |
start_time |
String |
参数说明:实例任务的开始时间。格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" |
end_time |
String |
参数说明:实例任务的结束时间。格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" |
target_config |
TargetConfig object |
实例规格变更时,实例的目标规格配置。 |
operate_window |
OperateWindow object |
实例维护时间窗,用户在变更实例规格时,可以指定在该时间窗内进行变更。 |
progress |
Integer |
参数说明:任务进度" |
参数 |
参数类型 |
描述 |
---|---|---|
flavor |
Flavor object |
参数说明:设备接入实例的规格参数。 |
charge_mode |
String |
参数说明:实例的付费方式。 取值范围:
|
请求示例
查询实例任务详情。
GET https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}/tasks/{task_id}
响应示例
状态码:200
OK
{ "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.standard.s2", "size" : 2 } }, "operate_window" : { "start_time" : "18:00", "end_time" : "22:00" }, "progress" : 80 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
错误码
请参见错误码。