Lacak status tugas asynchronous melalui GetTaskStatus - CloudSSO - Alibaba Cloud - CloudSSO

Deskripsi operasi

You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the GetTask operation.

This topic provides an example on how to query the information about the task whose ID is t-shfqw1u1edszvxw5****.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:GetTaskStatus

get

*Directory

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	ID direktori.	d-00fc2p61****
TaskId	string	Yes	ID Tugas.	t-shfqw1u1edszvxw5****

Elemen respons

Element	Type	Description	Example
	object	The returned results.
RequestId	string	The request ID.	005F4623-AE53-504D-830F-44825F7DC211
TaskStatus	object	The status information about the task.
Status	string	The task status. Valid values: InProgress: The task is running. Success: The task is successful. Failed: The task failed.	Success
TaskId	string	The task ID.	t-shfqw1u1edszvxw5****
EndTime	string	The end time of the task.	2021-11-05T02:58:08Z
TaskType	string	The task type. Valid values: ProvisionAccessConfiguration: An access configuration is provisioned. DeprovisionAccessConfiguration: An access configuration is de-provisioned. CreateAccessAssignment: Access permissions on an account in the resource directory are assigned. DeleteAccessAssignment: Access permissions on an account in the resource directory are removed.	DeleteAccessAssignment
FailureReason	string	The cause of the task failure. Catatan This parameter is returned only when the value of `Status` is `Failed`.	No Permission.
StartTime	string	The start time of the task.	2021-11-05T02:58:07Z

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.