文档

ListTasks - 查询异步任务列表

更新时间:
一键部署

调用ListTasks查询异步任务列表。

接口说明

本 API 默认查询距离当前时间 24 小时内的任务列表。最多支持查询 7 天内的任务列表。您可以通过Filter参数设置查询的开始时间。

本文将提供一个示例,查询 24 小时内的任务列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudsso:ListTasksRead
  • Directory
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

请求参数

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

目录 ID。

d-00fc2p61****
AccessConfigurationIdstring

访问配置 ID,用于查询的过滤条件。

ac-00jhtfl8thteu6uj****
TargetTypestring

任务目标类型,用于查询的过滤条件。

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

说明 TargetIdTargetType必须同时配置才能作为有效的过滤条件进行查询。
RD-Account
TargetIdstring

任务目标 ID,用于查询的过滤条件。

说明 TargetIdTargetType必须同时配置才能作为有效的过滤条件进行查询。
114240524784****
PrincipalTypestring

云 SSO 身份类型,用于查询的过滤条件。取值:

  • User:用户。
  • Group:用户组。
说明 PrincipalIdPrincipalType必须同时配置才能作为有效的过滤条件进行查询。
User
PrincipalIdstring

云 SSO 身份 ID,用于查询的过滤条件。具体如下:

  • PrincipalTypeUser时,PrincipalId为云 SSO 用户 ID。
  • PrincipalTypeGroup时,PrincipalId为云 SSO 用户组 ID。
说明 PrincipalIdPrincipalType必须同时配置才能作为有效的过滤条件进行查询。
u-00q8wbq42wiltcrk****
TaskTypestring

任务类型,用于查询的过滤条件。取值:

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

任务状态,用于查询的过滤条件。取值:

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

查询返回结果下一页的令牌。首次调用 API 不需要NextToken

当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncatedtrue,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncatedfalse,表示全部数据查询完毕。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResultsinteger

每页的最大数据条数。

取值范围:1~20。

默认值:10。

10
Filterstring

过滤条件。

格式: ,不区分大小写。其中,只支持 StartTime,只支持 ge(Greater Than or Equals),格式为 YYYY-MM-DDTHH:mm:SSZ,且只能填写距离当前时间不超过 7 天的值。

示例:Filter = "StartTime ge 2021-03-15T01:12:23Z",表示查询从 2021-03-15T01:12:23 GMT(0 时区)时间开始的任务列表。

说明 如不指定该参数,则默认返回距离当前时间 24 小时内的任务列表。
StartTime ge 2021-03-15T01:12:23Z

返回参数

名称类型描述示例值
object

返回结果。

Tasksobject []

任务列表。

Statusstring

任务状态。取值:

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

任务 ID。

t-sh5k4gesm6twlrqb****
EndTimestring

任务结束时间。

2021-11-09T05:50:50Z
PrincipalIdstring

云 SSO 身份 ID。

u-00q8wbq42wiltcrk****
TargetPathstring

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

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

任务开始时间。

2021-11-09T05:50:50Z
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 账号上的授权。
CreateAccessAssignment
FailureReasonstring

任务失败原因。

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

任务目标类型。

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

RD-Account
AccessConfigurationIdstring

访问配置 ID。

ac-00jhtfl8thteu6uj****
PrincipalTypestring

云 SSO 身份类型。取值:

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

查询返回结果下一页的令牌。

说明 只有IsTruncatedtrue,才显示该参数。
K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestIdstring

请求 ID。

C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3
MaxResultsinteger

每页的最大数据条数。

10
TotalCountsinteger

符合请求参数条件的数据总条数。

1
IsTruncatedboolean

返回结果是否被截断。取值:

  • true:已截断。
  • false:未截断。
false

示例

正常返回示例

JSON格式

{
  "Tasks": [
    {
      "Status": "Success",
      "TaskId": "t-sh5k4gesm6twlrqb****",
      "EndTime": "2021-11-09T05:50:50Z",
      "PrincipalId": "u-00q8wbq42wiltcrk****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "StartTime": "2021-11-09T05:50:50Z",
      "PrincipalName": "Alice",
      "TargetName": "dev-test",
      "TargetId": "114240524784****",
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "TaskType": "CreateAccessAssignment",
      "FailureReason": "No Permission.",
      "TargetType": "RD-Account",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
      "PrincipalType": "User"
    }
  ],
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3",
  "MaxResults": 10,
  "TotalCounts": 1,
  "IsTruncated": false
}

错误码

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

  • 本页导读 (1)