非同期タスクをクエリします。
操作説明
デフォルトでは、この操作は過去 24 時間以内のタスクをクエリします。この操作では、最大 7 日以内のタスクをクエリできます。Filter を使用してクエリの開始時刻を指定できます。
このトピックでは、過去 24 時間以内のタスクをクエリする方法の例を示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cloudsso:ListTasks |
list |
*Directory
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DirectoryId |
string |
必須 |
ディレクトリの ID。 |
d-00fc2p61**** |
| AccessConfigurationId |
string |
任意 |
アクセス構成の ID。この ID を使用して、アクセス権限をフィルターできます。 |
ac-00jhtfl8thteu6uj**** |
| TargetType |
string |
任意 |
タスクオブジェクトのタイプ。このタイプを使用して、アクセス権限をフィルターできます。 値を `RD-Account` に設定します。これは、リソースディレクトリ内のアカウントを指定します。 説明
|
RD-Account |
| TargetId |
string |
任意 |
タスクオブジェクトの ID。この ID を使用して、アクセス権限をフィルターできます。 説明
|
114240524784**** |
| PrincipalType |
string |
任意 |
CloudSSO ID のタイプ。このタイプを使用して、アクセス権限をフィルターできます。有効な値:
説明
|
User |
| PrincipalId |
string |
任意 |
CloudSSO ID。この ID を使用して、アクセス権限をフィルターできます。
説明
|
u-00q8wbq42wiltcrk**** |
| TaskType |
string |
任意 |
タスクのタイプ。このタイプを使用して、タスクをフィルターできます。有効な値:
|
CreateAccessAssignment |
| Status |
string |
任意 |
タスクのステータス。このステータスを使用して、タスクをフィルターできます。有効な値:
|
Success |
| NextToken |
string |
任意 |
次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。この操作を初めて呼び出す場合は、 この操作を初めて呼び出すときに、返されるエントリの総数が |
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 |
タスクのステータス。有効な値:
|
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 |
タスクタイプ。有効な値:
|
CreateAccessAssignment |
| FailureReason |
string |
タスク失敗の原因。 説明
このパラメーターは、 |
No Permission. |
| TargetType |
string |
タスクオブジェクトのタイプ。 値は `RD-Account` に固定されており、リソースディレクトリ内のアカウントを示します。 |
RD-Account |
| AccessConfigurationId |
string |
アクセス構成の ID。 |
ac-00jhtfl8thteu6uj**** |
| PrincipalType |
string |
CloudSSO ID のタイプ。有効な値:
|
User |
| NextToken |
string |
NextToken の戻り値はページネーショントークンであり、次のリクエストで新しい結果ページを取得するために使用できます。 説明
このパラメーターは、 |
K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
| RequestId |
string |
リクエスト ID。 |
C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3 |
| MaxResults |
integer |
1 ページあたりに返される最大エントリ数。 |
10 |
| TotalCounts |
integer |
返されたエントリの総数。 |
1 |
| IsTruncated |
boolean |
クエリされたエントリが切り捨てられているかどうかを示します。有効な値:
|
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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。