文档首页/ 密码安全中心 DEW/ API参考/ API说明/ 管理SSH密钥对/ 密钥对任务管理/ 查询任务信息 - ListKeypairTask
更新时间：2025-10-16 GMT+08:00
查看PDF
分享

查询任务信息 - ListKeypairTask

功能介绍

根据SSH密钥对接口返回的task_id，查询SSH密钥对当前任务的执行状态。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kps::getTask

    List

    -

    -
    • kps:domainKeypairs:gettask

    -

URI

GET /v3/{project_id}/tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

task_id

是

String

任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

server_id

String

租户虚拟机ID

task_id

String

任务下发成功返回的ID

task_status

String

密钥对正在处理的状态。

  • READY_RESET 准备重置

  • RUNNING_RESET 正在重置

  • FAILED_RESET 重置失败

  • SUCCESS_RESET 重置成功

  • READY_REPLACE 准备替换

  • RUNNING_REPLACE 正在替换

  • FAILED_RESET 替换失败

  • SUCCESS_RESET 替换成功

  • READY_UNBIND 准备解绑

  • RUNNING_UNBIND 正在解绑

  • FAILED_UNBIND 解绑失败

  • SUCCESS_UNBIND 解绑成功

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c",
  "task_status" : "RUNNING_RESET",
  "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006"
}

状态码：400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

200

OK

400

Error response

错误码

请参见错误码。

父主题： 密钥对任务管理