調用ListSynchronizationJobs介面查詢同步任務-應用身份服務 (IDaaS)-阿里雲

列表查詢同步任務詳情資訊。

介面說明

支援以下兩種方式查看返回資料：

方式一：分頁查詢首頁時，僅需設定 MaxResults 以限制返回資訊的條目數，返回結果中的 NextToken 將作為查詢後續頁的憑證。查詢後續頁時，將 NextToken 參數設定為上一次返回結果中擷取到的 NextToken 作為查詢憑證，並設定 MaxResults 限制返回條目數。如果沒有下一頁時，NextToken 不再返回。MaxResults 最大值為 100。
方式二：通過 PageSize 設定單頁返回的條目數，再通過 PageNumber 設定頁碼。

以上兩種方式只能任選其中之一。當返回的條目數較多時，推薦使用方式一。如果設定了 MaxResults 或 NextToken 參數，則請求參數 PageSize 和 PageNumber 將失效。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

eiam:ListSynchronizationJobs

list

*SynchronizationJob

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

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	否	列表頁碼，從 1 開始。	1
PageSize	integer	否	列表大小，最大值 100。	10
NextToken	string	否	查詢下一頁憑證（Token），如果沒有下一頁時，該參數不再返回。	NTxxxxxexample
MaxResults	integer	否	分頁查詢時每頁行數，最大值 100。	20
TargetType	string	否	同步目標類型，取值可選範圍： identity_provider：身份提供方 application：應用	identity_provider
TargetIds	array	否	同步目標 ID 列表。[idp_111XXXX,idp_222XXXX]	target_001
	string	否	同步目標 ID	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	否	同步開始時間，Unix 時間戳記格式，單位為毫秒。	1649830226000
EndTime	integer	否	同步結束時間，Unix 時間戳記格式，單位為毫秒。	1649830226000
Direction	string	否	同步任務方向，取值可選範圍： ingress：入方向 egress：出方向	ingress
Status	string	否	同步任務狀態，取值可選範圍： pending：初始狀態 running：運行中 failed：失敗 partial_success：部分成功 success：成功	running
Filters	array<object>	否	過濾參數
	object	否	過濾參數
Key	string	否	動態參數名稱	qps
Values	array	否	動態參數值
	string	否	動態參數值	[]

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	列表總條數目。	100
NextToken	string	本次調用返回的查詢憑證（Token）值。	NTxxxexample
SynchronizationJobs	array<object>	同步任務資訊列表
	object	同步任務詳情。
SynchronizationJobId	string	同步任務 ID	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	同步目標類型，取值可選範圍： identity_provider：身份提供方 application：應用	identity_provider
TargetId	string	同步目標 ID	idp_my664lwkhpicbyzirog3xxxxx
Direction	string	同步任務方向，取值可選範圍： ingress：入方向 egress：出方向	ingress
StartTime	integer	同步開始時間，Unix 時間戳記格式，單位為毫秒。	1649830226000
EndTime	integer	同步結束時間，Unix 時間戳記格式，單位為毫秒。	1649830226000
TriggerType	string	同步觸發類型，取值可選範圍： auto：自動觸發 manual：手動觸發	auto
Status	string	同步任務狀態，取值可選範圍： pending：初始狀態 running：運行中 failed：失敗 partial_success：部分成功 success：成功	success
Result	object	同步任務結果
UserStatistics	object	使用者同步結果統計
Created	object	建立結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Updated	object	更新結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Binded	object	綁定結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Deleted	object	刪除結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Same	object	相同結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Pushed	object	推送結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Exported	object	匯出結果統計
Total	integer	總共數目	5
Success	integer	成功數目	2
Failed	integer	失敗數目	2
Skipped	integer	跳過數目	1
OrganizationalUnitStatistics	object	組織同步結果統計
Created	object	建立結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Updated	object	更新結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Binded	object	綁定結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Deleted	object	刪除結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Same	object	相同結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Pushed	object	推送結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
GroupStatistics	object	組同步結果統計
Created	object	建立結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Updated	object	更新結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Binded	object	綁定結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Deleted	object	刪除結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Same	object	相同結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Pushed	object	推送結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
GroupMemberStatistics	object	群組成員同步結果統計
Created	object	建立結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Updated	object	更新結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Binded	object	綁定結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Deleted	object	刪除結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Same	object	相同結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
Pushed	object	推送結果統計
Total	integer	總共數目	3
Success	integer	成功數目	1
Failed	integer	失敗數目	1
Skipped	integer	跳過數目	1
ErrorMessage	string	同步結果錯誤資訊描述	The specified parameter Username is required!
ErrorCode	string	同步結果錯誤碼	MissingParameter.Username
Description	string	同步任務描述	Description

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "SynchronizationJobs": [
    {
      "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx\n",
      "TargetType": "identity_provider",
      "TargetId": "idp_my664lwkhpicbyzirog3xxxxx\n",
      "Direction": "ingress",
      "StartTime": 1649830226000,
      "EndTime": 1649830226000,
      "TriggerType": "auto",
      "Status": "success",
      "Result": {
        "UserStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Exported": {
            "Total": 5,
            "Success": 2,
            "Failed": 2,
            "Skipped": 1
          }
        },
        "OrganizationalUnitStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "GroupStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "GroupMemberStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "ErrorMessage": "The specified parameter Username is required!",
        "ErrorCode": "MissingParameter.Username"
      },
      "Description": " Description"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。