云服务器内容精选

  • 响应说明 表3 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 total Int body False 总记录数 jobs RpaDetailJobResult[] body False 任务列表,成功时必须返回。 表4 RpaDetailJobResult 参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid String body False 任务UUID jobName String body False 任务名称 createTime String body False 任务创建时间 startTime String body False 任务开始时间 status String body False 任务状态,枚举类型为: init:待执行 running:运行 success:完成 suspend:暂停 mode string body False 执行方式:once、repeat runMode string body False 运行模式:在线online;离线offline timeout Integer body False 任务的超时时间,单位s description string body False 任务描述
  • 报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "hjbLf*******************RQFv3nq", "pageNo": 1, "pageSize": 10, "conditions": {} } 响应消息样例 { "total": 1, "jobs": [ { "uid": "0c9358552188478a8d5ff9203db8791f", "jobName": "AICC_RPA", "createTime": "2022-04-24 17:12:02", "startTime": "2022-04-29 11:47:25", "status": "running", "mode": "queueTrigger", "runMode": "online", "timeout": 120, "description": null } ], "errorCode": 0, "errorMsg": null }
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度:64 pageNo Integer body False 查询页数,默认1页 pageSize Integer body False 每页多少条,默认50条 可选值:5,10,20,50 conditions RpaJobCondition body False 查询条件 authToken String body True 访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度:32 表2 RpaJobConditions参数 参数名称 数据类型 参数位置 必选/可选 描述 jobName String body False 任务名称模糊查询 status Integer body False 任务状态条件搜索,如下: init:待执行 running:运行 suspend:暂停 success:完成
  • 报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "oqyo*******************fGMCu", "pageNo": 1, "pageSize": 10, "conditions": { "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a" } } 响应消息样例 { "errorCode": 0, "errorMsg": null, "total": 1, "queueData": [ { "id": 44, "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueName": "创建工单", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "createTime": 1651027548328, "expectStartTime": null, "expectEndTime": null, "status": "success", "priority": "normal", "inactived": "active", "tag": null, "inputJsonData": "{\"caseId\":\"0607000000t1FY2F0Mb2\"}", "outputJsonData": null, "analysisJsonData": null, "failedReason": null, "failedReasonDetail": null, "description": "描述队列数据", "progress": null } ] }
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度:64 authToken String body True 访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度:32 pageNo Integer body False 查询页数,默认1页 pageSize Integer body False 每页多少条,默认50条 可选值:5,10,20,50 conditions RpaQueueDataConditions body True 查询条件。 队列数据uid或者队列queueUid必须传入一个值。 表2 RpaQueueDataConditions参数 参数名称 数据类型 参数位置 必选/可选 描述 uid string body False 根据队列数据UUID查询(至少传递uid、queueUid、queueName中一个参数) queueUid string body False 根据队列数据UUID查询(至少传递uid、queueUid、queueName中一个参数) queueName string(32) body False 根据队列名称查询(至少传递uid、queueUid、queueName中一个参数) tag string body False 根据队列数据标签查询 status string body False 根据队列状态查询,枚举类型为 init:等待处理 processing:处理中 success:成功 failed:失败 inactived string body False 根据队列启用状态查询,枚举类型为: active:已启用 inactive:已停用 不传该参数,默认查询已启用 priority string body False 根据队列优先级查询,枚举类型为: low:低 normal:中 high:高
  • 响应说明 表3 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 total int body False 队列数据条数,成功时必须返回。 queueData QueueData[] body False 队列数据,成功时必须返回。 表4 QueueData参数说明 参数名称 数据类型 参数位置 必选/可选 描述 id long body False 队列数据自增ID uid string body False 队列数据UUID queueName string(32) body False 队列名称 queueUid string body False 队列UUID createTime long body False 创建时间(0-7258089600000L)时间戳 expectStartTime long body False 计划开始时间(0-7258089600000L)时间戳 expectEndTime long body False 计划结束时间(0-7258089600000L)时间戳 status string body False 队列状态枚举类型为: init:等待处理 processing:处理中 success:成功 failed:失败 priority string body False 优先级枚举类型为: low:低 normal:中 high:高 inactived string body False 队列启用状态枚举类型为: active:已启用 inactive:已停用 tag string(32) body False 队列数据标签 inputJsonData string(65535) body False 输入的队列数据,json格式字符串 outputJsonData string(65535) body False 输出的结果数据,json格式字符串 analysisJsonData string(65535) body False 中间的队列数据,json格式字符串 failedReason string(512) body False 失败原因 failedReasonDetail string(65535) body False 失败原因细节 description string(100) body False 队列数据描述 progress int body False 进度(0-100)
  • 报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "hjbLfhU*******************Fv3nq", "uid": "0c9358552188478a8d5ff9203db8791f"} 响应消息样例 { "errorCode": 0, "errorMsg": null, "jobDetail": { "jobName": "AICC_RPA", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "workstationName": "AICC_RPA", "runMode": "online", "timeout": 120, "mode": "queueTrigger", "uid": "0c9358552188478a8d5ff9203db8791f", "procedureVersion": "1.0.5", "queueName": "创建工单", "createTime": "2022-04-24 17:12:02", "procedureName": "AICC_RPA", "startTime": "2022-04-29 11:47:25", "jobType": "procedure", "recentTaskStatus": "failed", "status": "running" }}
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度:64 jobName String body False 任务名称(根据jobName来查询,uid可设置为null,jobName或者uid必须传入一个值。) uid String body False 任务UUID(jobName和uid都填,以uid为准,jobName或者uid必须传入一个值。) authToken String body True 访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度:32
  • 响应说明 表2 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 jobDetail RpaDetailJobResult[] body False 队列详情 表3 RpaDetailJobResult参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid string body True 任务UUID jobName string body True 任务的名称 startTime string body False 作业开始时间, 格式:yyyy-mm-dd HH:mm:ss createTime string body True 作业创建时间, 格式:yyyy-mm-dd HH:mm:ss workstationName string body False 执行器名称 clusterName string body False 集群名称 runMode string body True 运行模式:在线online mode string body True 执行方式:once、repeat、queueTrigger jobType string body True 任务类型固定为procedure status string body True 任务状态条件搜索,如下: init:待执行 running:运行 suspend:暂停 success:完成 procedureName string body True 脚本包名称 procedureVersion string body True 脚本包版本 description string body True 任务描述 timeout int body False 任务超时时间 recentTaskStatus string body False 最近一次作业状态,没有生成作业的任务不会返回该字段 queueUid string body False 队列的UUID queueName string body False 队列名称