GetTask API参考与异步任务查询-云SSO-阿里云-云SSO(CloudSSO)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cloudsso:GetTask

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

无

请求参数

名称	类型	必填	描述	示例值
DirectoryId	string	是	目录 ID。	d-00fc2p61****
TaskId	string	是	任务 ID。	t-shfqw1u1edszvxw5****

返回参数

名称	类型	描述	示例值
	object	返回结果。
Task	object	任务信息。
Status	string	任务状态。取值： InProgress：任务执行中。 Success：任务执行成功。 Failed：任务执行失败。	Success
TaskId	string	任务 ID。	t-shfqw1u1edszvxw5****
EndTime	string	任务结束时间。格式为 RFC 3339 的 UTC 时间（YYYY-MM-DDTHH:mm:ssZ）。	2021-11-05T02:58:08Z
PrincipalId	string	云 SSO 身份 ID。	u-00q8wbq42wiltcrk****
TargetPath	string	任务目标在资源目录中的路径 ID。	rd-3G**/r-Wm/114240524784**
StartTime	string	任务开始时间。格式为 RFC 3339 的 UTC 时间（YYYY-MM-DDTHH:mm:ssZ）。	2021-11-05T02:58:07Z
PrincipalName	string	云 SSO 身份名称。	Alice
TargetName	string	任务目标名称。	dev-test
TargetId	string	任务目标 ID。	114240524784****
AccessConfigurationName	string	访问配置名称。	ECS-Admin
TargetPathName	string	任务目标在资源目录中的路径名称。	rd-3G****/root/dev-test
TaskType	string	任务类型。取值： ProvisionAccessConfiguration：部署访问配置。 DeprovisionAccessConfiguration：解除访问配置部署。 CreateAccessAssignment：在 RD 账号上授权。 DeleteAccessAssignment：移除 RD 账号上的授权。	DeleteAccessAssignment
FailureReason	string	任务失败原因。说明只有`Status`为`Failed`，才会显示该参数。	No Permission.
TargetType	string	任务目标类型。取值：RD-Account，表示任务目标类型为 RD 账号。	RD-Account
AccessConfigurationId	string	访问配置 ID。	ac-00jhtfl8thteu6uj****
PrincipalType	string	云 SSO 身份类型。取值： User：用户。 Group：用户组。	User
OriginTargetId	string	目标所属的云账号 ID	17xxxxxxxxxxxx73
RequestId	string	请求 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",
    "OriginTargetId": "17xxxxxxxxxxxx73"
  },
  "RequestId": "923CA5E8-57BF-5E15-8BA6-E75A966B7E3F"
}

错误码

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

变更历史

更多信息，参考变更详情。