Referensi API GetSynchronizationJob - Identity as a Service - Alibaba Cloud - Identity as a Service

Memperoleh informasi tentang satu tugas sinkronisasi.

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

eiam:GetSynchronizationJob

get

*SynchronizationJob

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
SynchronizationJobId	string	Yes	ID tugas sinkronisasi.	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJob	object	Informasi tentang tugas sinkronisasi.
SynchronizationJobId	string	ID tugas sinkronisasi.	sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx
TargetType	string	Jenis tujuan sinkronisasi. Nilai yang valid: identity_provider application	identity_provider
TargetId	string	ID tujuan sinkronisasi.	idp_my664lwkhpicbyzirog3nxxxxx
Direction	string	Arah tugas sinkronisasi. Nilai yang valid: ingress egress	ingress
StartTime	integer	Waktu mulai sinkronisasi. Nilai ini adalah stempel waktu UNIX yang merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.	1649830226000
EndTime	integer	Waktu akhir sinkronisasi. Nilai ini adalah stempel waktu UNIX yang merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.	1649830226000
TriggerType	string	Jenis pemicu sinkronisasi. Nilai yang valid: auto manual	auto
Status	string	Status tugas sinkronisasi. Nilai yang valid: pending running failed partial_success success	running
Result	object	Hasil tugas sinkronisasi.
UserStatistics	object	The user synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical users.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	10
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
OrganizationalUnitStatistics	object	The organization synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical organizations.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
GroupStatistics	object	The group synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical groups.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
GroupMemberStatistics	object	The group member synchronization result statistics.
Created	object	The creation result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Updated	object	The update result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Binded	object	The binding result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Deleted	object	The deletion result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Same	object	The result statistics about identical group members.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
Pushed	object	The notification result statistics.
Total	integer	The total number of items.	30
Success	integer	The number of successful items.	10
Failed	integer	The number of failed items.	10
Skipped	integer	The number of skipped items.	10
ErrorMessage	string	The error message returned in the case of an error.	内部错误
ErrorCode	string	The error code corresponding to the error message.	ErrorCodeNotFound

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "SynchronizationJob": {
    "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx\n",
    "TargetType": "identity_provider",
    "TargetId": "idp_my664lwkhpicbyzirog3nxxxxx\n",
    "Direction": "ingress",
    "StartTime": 1649830226000,
    "EndTime": 1649830226000,
    "TriggerType": "auto",
    "Status": "running",
    "Result": {
      "UserStatistics": {
        "Created": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 10,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "OrganizationalUnitStatistics": {
        "Created": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "GroupStatistics": {
        "Created": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "GroupMemberStatistics": {
        "Created": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Updated": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Binded": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Deleted": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Same": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        },
        "Pushed": {
          "Total": 30,
          "Success": 10,
          "Failed": 10,
          "Skipped": 10
        }
      },
      "ErrorMessage": "内部错误",
      "ErrorCode": "ErrorCodeNotFound"
    }
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.