すべてのプロダクト
Search
ドキュメントセンター

CloudSSO:ListTasks

最終更新日:Dec 20, 2025

非同期タスクをクエリします。

操作説明

デフォルトでは、この操作は過去 24 時間以内のタスクをクエリします。この操作では、最大 7 日以内のタスクをクエリできます。Filter を使用してクエリの開始時刻を指定できます。

このトピックでは、過去 24 時間以内のタスクをクエリする方法の例を示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cloudsso:ListTasks

list

*Directory

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DirectoryId

string

必須

ディレクトリの ID。

d-00fc2p61****

AccessConfigurationId

string

任意

アクセス構成の ID。この ID を使用して、アクセス権限をフィルターできます。

ac-00jhtfl8thteu6uj****

TargetType

string

任意

タスクオブジェクトのタイプ。このタイプを使用して、アクセス権限をフィルターできます。

値を `RD-Account` に設定します。これは、リソースディレクトリ内のアカウントを指定します。

説明

TargetIdTargetType の両方を指定した場合にのみ、タイプを使用してアクセス権限をフィルターできます。

RD-Account

TargetId

string

任意

タスクオブジェクトの ID。この ID を使用して、アクセス権限をフィルターできます。

説明

TargetIdTargetType の両方を指定した場合にのみ、タイプを使用してアクセス権限をフィルターできます。

114240524784****

PrincipalType

string

任意

CloudSSO ID のタイプ。このタイプを使用して、アクセス権限をフィルターできます。有効な値:

  • User

  • Group

説明

PrincipalIdPrincipalType の両方を指定した場合にのみ、タイプを使用してアクセス権限をフィルターできます。

User

PrincipalId

string

任意

CloudSSO ID。この ID を使用して、アクセス権限をフィルターできます。

  • PrincipalTypeUser に設定した場合、PrincipalId を CloudSSO ユーザーの ID に設定します。

  • PrincipalTypeGroup に設定した場合、PrincipalId を CloudSSO グループの ID に設定します。

説明

PrincipalIdPrincipalType の両方を指定した場合にのみ、タイプを使用してアクセス権限をフィルターできます。

u-00q8wbq42wiltcrk****

TaskType

string

任意

タスクのタイプ。このタイプを使用して、タスクをフィルターできます。有効な値:

  • ProvisionAccessConfiguration:アクセス構成がプロビジョニングされます。

  • DeprovisionAccessConfiguration:アクセス構成のプロビジョニングが解除されます。

  • CreateAccessAssignment:リソースディレクトリ内のアカウントに対するアクセス権限が割り当てられます。

  • DeleteAccessAssignment:リソースディレクトリ内のアカウントに対するアクセス権限が削除されます。

CreateAccessAssignment

Status

string

任意

タスクのステータス。このステータスを使用して、タスクをフィルターできます。有効な値:

  • InProgress:タスクは実行中です。

  • Success:タスクは成功しました。

  • Failed:タスクは失敗しました。

Success

NextToken

string

任意

次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。この操作を初めて呼び出す場合は、NextToken パラメーターを指定する必要はありません。

この操作を初めて呼び出すときに、返されるエントリの総数が MaxResults の値を超えると、エントリは切り捨てられます。MaxResults の値に一致するエントリのみが返され、超過したエントリは返されません。この場合、レスポンスパラメーター IsTruncated の値は true になり、NextToken が返されます。次の呼び出しでは、NextToken の値を使用し、他のリクエストパラメーターの設定を維持して、超過したエントリをクエリできます。IsTruncated の値が false になるまで呼び出しを繰り返すことができます。これにより、すべてのエントリが返されます。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

MaxResults

integer

任意

1 ページあたりの最大エントリ数。

有効な値:1~20。

デフォルト値:10。

10

Filter

string

任意

フィルター条件。

条件では大文字と小文字は区別されません。条件は `StartTime ge YYYY-MM-DDTHH:mm:SSZ` フォーマットである必要があります。`YYYY-MM-DDTHH:mm:SSZ` は、現在時刻から 7 日以内の値に設定する必要があります。`ge` は「以上」 (Greater Than or Equals) を示します。

たとえば、`Filter` パラメーターを `StartTime ge 2021-03-15T01:12:23Z` に設定すると、この操作は 2021-03-15T01:12:23 GMT からのタスクをクエリします。

説明

このパラメーターを指定しない場合、操作はデフォルトで過去 24 時間以内のタスクをクエリします。

StartTime ge 2021-03-15T01:12:23Z

レスポンスフィールド

フィールド

説明

object

戻り値。

Tasks

array<object>

タスク。

object

Status

string

タスクのステータス。有効な値:

  • InProgress:タスクは実行中です。

  • Success:タスクは成功しました。

  • Failed:タスクは失敗しました。

Success

TaskId

string

タスクの ID。

t-sh5k4gesm6twlrqb****

EndTime

string

タスクの終了時刻。

2021-11-09T05:50:50Z

PrincipalId

string

CloudSSO ID。

u-00q8wbq42wiltcrk****

TargetPath

string

リソースディレクトリ内のタスクオブジェクトのパス ID。

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

StartTime

string

タスクの開始時刻。

2021-11-09T05:50:50Z

PrincipalName

string

CloudSSO ID の名前。

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:リソースディレクトリ内のアカウントに対するアクセス権限が割り当てられます。

  • DeleteAccessAssignment:リソースディレクトリ内のアカウントに対するアクセス権限が削除されます。

CreateAccessAssignment

FailureReason

string

タスク失敗の原因。

説明

このパラメーターは、Status の値が Failed の場合にのみ返されます。

No Permission.

TargetType

string

タスクオブジェクトのタイプ。

値は `RD-Account` に固定されており、リソースディレクトリ内のアカウントを示します。

RD-Account

AccessConfigurationId

string

アクセス構成の ID。

ac-00jhtfl8thteu6uj****

PrincipalType

string

CloudSSO ID のタイプ。有効な値:

  • User

  • Group

User

NextToken

string

NextToken の戻り値はページネーショントークンであり、次のリクエストで新しい結果ページを取得するために使用できます。

説明

このパラメーターは、IsTruncated の値が true の場合にのみ返されます。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

RequestId

string

リクエスト ID。

C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3

MaxResults

integer

1 ページあたりに返される最大エントリ数。

10

TotalCounts

integer

返されたエントリの総数。

1

IsTruncated

boolean

クエリされたエントリが切り捨てられているかどうかを示します。有効な値:

  • true

  • false

false

成功レスポンス

JSONJSON

{
  "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
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。