文档

GetTask - 查询异步任务信息

更新时间:
一键部署

调用GetTask查询异步任务信息。

接口说明

本文将提供一个示例,查询 ID 为t-shfqw1u1edszvxw5****的任务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DirectoryIdstring

目录 ID。

d-00fc2p61****
TaskIdstring

任务 ID。

t-shfqw1u1edszvxw5****

返回参数

名称类型描述示例值
object

返回结果。

Taskobject

任务信息。

Statusstring

任务状态。取值:

  • InProgress:任务执行中。
  • Success:任务执行成功。
  • Failed:任务执行失败。
Success
TaskIdstring

任务 ID。

t-shfqw1u1edszvxw5****
EndTimestring

任务结束时间。

2021-11-05T02:58:08Z
PrincipalIdstring

云 SSO 身份 ID。

u-00q8wbq42wiltcrk****
TargetPathstring

任务目标在资源目录中的路径 ID。

rd-3G****/r-Wm****/114240524784****
StartTimestring

任务开始时间。

2021-11-05T02:58:07Z
PrincipalNamestring

云 SSO 身份名称。

Alice
TargetNamestring

任务目标名称。

dev-test
TargetIdstring

任务目标 ID。

114240524784****
AccessConfigurationNamestring

访问配置名称。

ECS-Admin
TargetPathNamestring

任务目标在资源目录中的路径名称。

rd-3G****/root/dev-test
TaskTypestring

任务类型。取值:

  • ProvisionAccessConfiguration:部署访问配置。
  • DeprovisionAccessConfiguration:解除访问配置部署。
  • CreateAccessAssignment:在 RD 账号上授权。
  • DeleteAccessAssignment:移除 RD 账号上的授权。
DeleteAccessAssignment
FailureReasonstring

任务失败原因。

说明 只有StatusFailed,才会显示该参数。
No Permission.
TargetTypestring

任务目标类型。取值:RD-Account,表示任务目标类型为 RD 账号。

RD-Account
AccessConfigurationIdstring

访问配置 ID。

ac-00jhtfl8thteu6uj****
PrincipalTypestring

云 SSO 身份类型。取值:

  • User:用户。
  • Group:用户组。
User
RequestIdstring

请求 ID。

923CA5E8-57BF-5E15-8BA6-E75A966B7E3F

示例

正常返回示例

JSON格式

{
  "Task": {
    "Status": "Success",
    "TaskId": "t-shfqw1u1edszvxw5****",
    "EndTime": "2021-11-05T02:58:08Z",
    "PrincipalId": "u-00q8wbq42wiltcrk****",
    "TargetPath": "rd-3G****/r-Wm****/114240524784****",
    "StartTime": "2021-11-05T02:58:07Z",
    "PrincipalName": "Alice",
    "TargetName": "dev-test",
    "TargetId": "114240524784****",
    "AccessConfigurationName": "ECS-Admin",
    "TargetPathName": "rd-3G****/root/dev-test",
    "TaskType": "DeleteAccessAssignment",
    "FailureReason": "No Permission.",
    "TargetType": "RD-Account",
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
    "PrincipalType": "User"
  },
  "RequestId": "923CA5E8-57BF-5E15-8BA6-E75A966B7E3F"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)