Referensi API ListTasks untuk kueri tugas asinkron - CloudSSO - Alibaba Cloud - CloudSSO

Meminta tugas-tugas asinkron.

Deskripsi operasi

Secara default, operasi ini meminta tugas-tugas dalam 24 jam sebelumnya. Operasi ini memungkinkan Anda meminta tugas-tugas dalam jangka waktu maksimum 7 hari. Anda dapat menentukan waktu mulai kueri dengan menggunakan Filter.

Topik ini memberikan contoh tentang cara meminta tugas-tugas dalam 24 jam sebelumnya.

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:ListTasks

list

*Directory

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	ID direktori.	d-00fc2p61****
AccessConfigurationId	string	No	ID konfigurasi akses. ID ini dapat digunakan untuk memfilter izin akses.	ac-00jhtfl8thteu6uj****
TargetType	string	No	Tipe objek tugas. Tipe ini dapat digunakan untuk memfilter izin akses. Tetapkan nilainya ke RD-Account, yang menentukan akun-akun di direktori sumber daya. Catatan Anda hanya dapat menggunakan tipe untuk memfilter izin akses jika Anda menentukan baik `TargetId` maupun `TargetType`.	RD-Account
TargetId	string	No	ID objek tugas. ID ini dapat digunakan untuk memfilter izin akses. Catatan Anda hanya dapat menggunakan tipe untuk memfilter izin akses jika Anda menentukan baik `TargetId` maupun `TargetType`.	114240524784****
PrincipalType	string	No	Tipe identitas CloudSSO. Tipe ini dapat digunakan untuk memfilter izin akses. Nilai yang valid: User Group Catatan Anda hanya dapat menggunakan tipe untuk memfilter izin akses jika Anda menentukan baik `PrincipalId` maupun `PrincipalType`.	User
PrincipalId	string	No	ID identitas CloudSSO. ID ini dapat digunakan untuk memfilter izin akses. Jika Anda menetapkan `PrincipalType` ke `User`, tetapkan `PrincipalId` ke ID pengguna CloudSSO. Jika Anda menetapkan `PrincipalType` ke `Group`, tetapkan `PrincipalId` ke ID grup CloudSSO. Catatan Anda hanya dapat menggunakan tipe untuk memfilter izin akses jika Anda menentukan baik `PrincipalId` maupun `PrincipalType`.	u-00q8wbq42wiltcrk****
TaskType	string	No	Tipe tugas. Tipe ini dapat digunakan untuk memfilter tugas. Nilai yang valid: ProvisionAccessConfiguration: Konfigurasi akses disediakan. DeprovisionAccessConfiguration: Penyediaan konfigurasi akses dibatalkan. CreateAccessAssignment: Izin akses pada akun di direktori sumber daya diberikan. DeleteAccessAssignment: Izin akses pada akun di direktori sumber daya dihapus.	CreateAccessAssignment
Status	string	No	ID tugas. ID ini dapat digunakan untuk memfilter tugas. Nilai yang valid: InProgress: Tugas sedang berjalan. Success: Tugas berhasil. Failed: Tugas gagal.	Success
NextToken	string	No	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Jika ini adalah pertama kalinya Anda memanggil operasi ini, Anda tidak perlu menentukan parameter `NextToken`. Saat Anda memanggil operasi ini untuk pertama kalinya, jika total jumlah entri yang akan dikembalikan melebihi nilai `MaxResults`, entri akan dipotong. Hanya entri yang sesuai dengan nilai `MaxResults` yang dikembalikan, dan entri berlebih tidak dikembalikan. Dalam hal ini, nilai parameter respons `IsTruncated` adalah `true`, dan `NextToken` dikembalikan. Pada panggilan berikutnya, Anda dapat menggunakan nilai `NextToken` dan mempertahankan pengaturan parameter permintaan lainnya untuk meminta entri yang berlebih. Anda dapat mengulang panggilan sampai nilai `IsTruncated` menjadi `false`. Dengan cara ini, semua entri dikembalikan.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	No	Jumlah maksimum entri per halaman. Nilai yang valid: 1 hingga 20. Nilai default: 10.	10
Filter	string	No	Kondisi filter. Kondisi ini tidak peka huruf besar/kecil. Kondisi harus dalam format StartTime ge YYYY-MM-DDTHH:mm:SSZ. Anda harus menetapkan YYYY-MM-DDTHH:mm:SSZ ke nilai yang tidak lebih dari 7 hari dari waktu sekarang. ge berarti Lebih Besar Dari atau Sama Dengan. Sebagai contoh, jika Anda menetapkan parameter Filter ke StartTime ge 2021-03-15T01:12:23Z, operasi akan meminta tugas-tugas sejak 2021-03-15T01:12:23 GMT. Catatan Jika Anda tidak menentukan parameter ini, operasi akan meminta tugas-tugas dalam 24 jam sebelumnya secara default.	StartTime ge 2021-03-15T01:12:23Z

Elemen respons

Element	Type	Description	Example
	object	Hasil yang dikembalikan.
Tasks	array<object>	Daftar tugas.
	object
Status	string	Status tugas. Nilai yang valid: InProgress: Tugas sedang berjalan. Success: Tugas berhasil. Failed: Tugas gagal.	Success
TaskId	string	ID pekerjaan.	t-sh5k4gesm6twlrqb****
EndTime	string	Waktu selesai tugas.	2021-11-09T05:50:50Z
PrincipalId	string	ID identitas CloudSSO.	u-00q8wbq42wiltcrk****
TargetPath	string	ID jalur objek tugas di direktori sumber daya.	rd-3G**/r-Wm/114240524784**
StartTime	string	Waktu mulai tugas.	2021-11-09T05:50:50Z
PrincipalName	string	Nama identitas CloudSSO.	Alice
TargetName	string	Nama objek tugas.	dev-test
TargetId	string	ID objek tugas.	114240524784****
AccessConfigurationName	string	Nama konfigurasi akses.	ECS-Admin
TargetPathName	string	Nama jalur objek tugas di direktori sumber daya.	rd-3G****/root/dev-test
TaskType	string	Tipe tugas. Nilai yang valid: ProvisionAccessConfiguration: Konfigurasi akses disediakan. DeprovisionAccessConfiguration: Penyediaan konfigurasi akses dibatalkan. CreateAccessAssignment: Izin akses pada akun di direktori sumber daya diberikan. DeleteAccessAssignment: Izin akses pada akun di direktori sumber daya dihapus.	CreateAccessAssignment
FailureReason	string	Penyebab kegagalan tugas. Catatan Parameter ini hanya dikembalikan ketika nilai `Status` adalah `Failed`.	No Permission.
TargetType	string	Tipe objek tugas. Nilainya tetap RD-Account, yang menunjukkan akun-akun di direktori sumber daya.	RD-Account
AccessConfigurationId	string	ID konfigurasi akses.	ac-00jhtfl8thteu6uj****
PrincipalType	string	Tipe identitas CloudSSO. Nilai yang valid: User Group	User
NextToken	string	Nilai NextToken yang dikembalikan adalah token paginasi, yang dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Catatan Parameter ini hanya dikembalikan ketika nilai `IsTruncated` adalah `true`.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	ID permintaan.	C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3
MaxResults	integer	Jumlah maksimum entri yang dikembalikan per halaman.	10
TotalCounts	integer	Total jumlah entri yang dikembalikan.	1
IsTruncated	boolean	Menunjukkan apakah entri hasil kueri dipotong. Nilai yang valid: true false	false

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.