集成 API
查询 API 集成升级任务详情
查询 API 集成导入升级任务的执行状态和结果。
鉴权方式
HAP 组织授权开放接口为每个组织提供一套独立的密钥信息(AppKey 和 SecretKey),组织可通过此密钥信息安全调用 HAP 平台开放的各类接口,包括人员组织管理、汇报关系管理、应用管理、流程待办等数据接口。
版本
请求地址
Path 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
upgradeId | string | 是 | 导入升级任务 ID |
Query 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
appKey | string | 是 | AppKey |
sign | string | 是 | 签名,参考组织授权签名 |
timestamp | integer<int64> | 是 | 时间戳(与签名所用时间戳一致,精度为毫秒) |
projectId | string | 是 | 组织编号 |
accountId | string | 是 | 操作人账号 ID |
响应参数
200成功| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 请求是否成功;升级任务最终结果须检查 data.status |
data | object | — |
data.upgradeId | string | 导入升级任务 ID |
data.createdAt | string | 任务创建时间 |
data.finishedAt | string | null | 任务完成时间,执行中为空 |
data.status | string | 任务状态:RUNNING 为执行中,SUCCESS 为执行成功,FAILED 为执行失败。 可选值: "RUNNING""SUCCESS""FAILED" |
data.mediaId | string | 上传媒体文件接口返回的文件 ID |
data.operatorId | string | 操作人账号 ID |
curl -X GET "https://example.com/v1/integration/ImportUpgrade/upgradeId?appKey=string&sign=string×tamp=0&projectId=string&accountId=string"{ "data": { "upgradeId": "upg_20250211_000001", "createdAt": "2025-02-11 12:40:00", "finishedAt": "2025-02-11 12:42:30", "status": "SUCCESS", "mediaId": "file_111", "operatorId": "user_123" }, "success": true}