GetTask - CloudSSO - Alibaba Cloud

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

操作説明

このトピックでは、ID が t-shfqw1u1edszvxw5**** のタスク情報をクエリする方法の例を示します。

今すぐお試しください

この 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: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	タスクの終了時刻。	2021-11-05T02:58:08Z
PrincipalId	string	CloudSSO ID の ID。	u-00q8wbq42wiltcrk****
TargetPath	string	リソースディレクトリ内のタスクオブジェクトのパス ID。	rd-3G**/r-Wm/114240524784**
StartTime	string	タスクの開始時刻。	2021-11-05T02:58:07Z
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：リソースディレクトリ内のアカウントからアクセス権限が削除されます。	DeleteAccessAssignment
FailureReason	string	タスクの失敗原因。説明このパラメーターは、`Status` の値が `Failed` の場合にのみ返されます。	No Permission.
TargetType	string	タスクオブジェクトのタイプ。値は RD-Account に固定されており、リソースディレクトリ内のアカウントを示します。	RD-Account
AccessConfigurationId	string	アクセス構成の ID。	ac-00jhtfl8thteu6uj****
PrincipalType	string	CloudSSO ID のタイプ。有効な値： User Group	User
RequestId	string	リクエスト ID。	923CA5E8-57BF-5E15-8BA6-E75A966B7E3F

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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