云服务器内容精选

  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识(必须58位) language 否 String 国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 表2 请求Body参数 参数 是否必选 参数类型 描述 jobId 是 String 任务ID
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data String 响应业务信息 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 状态码: 401 表5 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述 状态码: 500 表6 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应描述
  • 响应示例 状态码: 200 OK { "batchtasks" : [ { "task_id" : "5c8ba99030344005c02316ad", "task_name" : "testname", "task_type" : "softwareUpgrade", "targets" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ], "targets_filter" : { "group_ids" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ] }, "document" : { "package_id" : "32822e5744a45ede319d2c50" }, "task_policy" : { "schedule_time" : "20151212T121212Z", "retry_count" : 5, "retry_interval" : 60 }, "status" : "Success", "status_desc" : "string", "task_progress" : { "total" : 0, "processing" : 0, "success" : 0, "fail" : 0, "waitting" : 0, "fail_wait_retry" : 0, "stopped" : 0 }, "create_time" : "20151212T121212Z" } ], "page" : { "count" : 10, "marker" : "5c90fa7d3c4e4405e8525079" } }
  • URI GET /v5/iot/{project_id}/batchtasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 否 String 参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的任务列表,不携带该参数则会查询该用户下所有任务列表。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 task_type 是 String 参数说明:批量任务类型。 取值范围: softwareUpgrade: 软件升级任务 firmwareUpgrade: 固件升级任务 createDevices: 批量创建设备任务 deleteDevices: 批量删除设备任务 freezeDevices: 批量冻结设备任务 unfreezeDevices: 批量解冻设备任务 createCommands: 批量创建同步命令任务 createAsyncCommands: 批量创建异步命令任务 createMessages: 批量创建消息任务 updateDeviceShadows:批量配置设备影子任务 updateDevices:批量更新设备任务 status 否 String 参数说明:批量任务的状态,可选参数。 取值范围: Initializing: 初始化中。 Waitting: 等待中。 Processing: 执行中。 Success: 成功。 Fail: 失败。 PartialSuccess: 部分成功。 Stopped: 停止。 Stopping: 停止中。 limit 否 Integer 参数说明:分页查询时每页显示的记录数。 取值范围:1-50的整数,默认值为10。 最小值:1 最大值:50 缺省值:10 marker 否 String 参数说明:上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由 物联网平台 返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marker的数据记录。若不填写,则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据,则每次查询时必须填写上一次查询响应中的marker值。 取值范围:长度为24的十六进制字符串,默认值为ffffffffffffffffffffffff。 缺省值:ffffffffffffffffffffffff offset 否 Integer 参数说明:表示从marker后偏移offset条记录开始查询。默认为0,取值范围为0-500的整数。当offset为0时,表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑,您可以搭配marker使用该参数实现翻页,例如每页50条记录,1-11页内都可以直接使用offset跳转到指定页,但到11页后,由于offset限制为500,您需要使用第11页返回的marker作为下次查询的marker,以实现翻页到12-22页。 取值范围:0-500的整数,默认为0。 最小值:0 最大值:500 缺省值:0
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 最小长度:1 最大长度:36
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 最小长度:1 最大长度:36 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 参数说明:上传批量任务文件。 取值范围:当前仅支持xlsx/xls文件格式,且文件最大行数为100000行。
  • URI DELETE /v5/iot/{project_id}/batchtask-files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 参数说明:要删除的批量任务文件ID。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。 最小长度:1 最大长度:128 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 最小长度:1 最大长度:36
  • 响应示例 状态码: 200 返回查询到的任务详情 { "data" : { "jobInfo" : { "taskId" : "1309243162258308352", "userId" : "40086000004871666-369528171409614001", "taskType" : 1, "actionType" : 101, "status" : 2, "progress" : 100, "taskResultCode" : 1, "contentNum" : 1, "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "tenantId" : "40086000004871666", "beginTime" : "20231212095227", "endTime" : "20231212095227", "createTime" : "20231212095227" }, "taskInfos" : [ { "fileId" : "FuZmQ66CF0DdpKRG1Y29Iwajbq04Nhwu3", "status" : "1", "newFileId" : "FtEXHCpfqHueAHFbEmWZNkqUH_K866MVn", "srcContainerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" } ] }, "code" : 0, "msg" : "成功" }