GetTaskStatus - - Alibaba Cloud Dokümantasyon Merkezi

Operation description

Asenkron bir görevin durumunu sorgulamak için GetTaskStatus işlemini çağırabilirsiniz. Asenkron bir görev hakkında daha fazla bilgi sorgulamak istiyorsanız, GetTask işlemini çağırın.

Bu konu, kimliği t-shfqw1u1edszvxw5**** olan görev hakkındaki bilgileri sorgulamak için bir örnek sunar.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:GetTaskStatus

get

*Directory

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

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	Dizin kimliği.	d-00fc2p61****
TaskId	string	Yes	Görev kimliği.	t-shfqw1u1edszvxw5****

Response elements

Element	Type	Description	Example
	object	Döndürülen sonuçlar.
RequestId	string	İstek kimliği.	005F4623-AE53-504D-830F-44825F7DC211
TaskStatus	object	Görev hakkındaki durum bilgileri.
Status	string	Görev durumu. Geçerli değerler: InProgress: Görev çalışıyor. Success: Görev başarılı. Failed: Görev başarısız oldu.	Success
TaskId	string	Görev kimliği.	t-shfqw1u1edszvxw5****
EndTime	string	Görevin bitiş zamanı.	2021-11-05T02:58:08Z
TaskType	string	Görev türü. Geçerli değerler: ProvisionAccessConfiguration: Bir erişim yapılandırması sağlanır. DeprovisionAccessConfiguration: Bir erişim yapılandırması kaldırılır. CreateAccessAssignment: Kaynak dizinindeki bir hesap üzerinde erişim izinleri atanır. DeleteAccessAssignment: Kaynak dizinindeki bir hesap üzerindeki erişim izinleri kaldırılır.	DeleteAccessAssignment
FailureReason	string	Görev başarısızlığının nedeni. Not Bu parametre yalnızca Status değeri Failed olduğunda döndürülür.	No Permission.
StartTime	string	Görevin başlangıç zamanı.	2021-11-05T02:58:07Z

Examples

Success response

JSON format

{
  "RequestId": "005F4623-AE53-504D-830F-44825F7DC211",
  "TaskStatus": {
    "Status": "Success",
    "TaskId": "t-shfqw1u1edszvxw5****",
    "EndTime": "2021-11-05T02:58:08Z",
    "TaskType": "DeleteAccessAssignment",
    "FailureReason": "No Permission.",
    "StartTime": "2021-11-05T02:58:07Z"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.