ListSynchronizationJobs API で NextToken を使用して同期タスクをクエリ - IDaaS - Alibaba Cloud - Identity as a Service

同期タスクの詳細リストを照会します。

操作説明

返されたデータを表示するために、以下の 2 つのメソッドがサポートされています:

メソッド 1: 最初のページを照会する場合、MaxResults を設定して返されるエントリ数を制限するだけで済みます。応答の NextToken は、後続のページを照会するための認証情報として機能します。後続のページを照会する場合、NextToken パラメーターを前回の応答から取得した NextToken 値に設定してクエリの認証情報とし、MaxResults を設定して返されるエントリ数を制限します。これ以上ページがない場合、NextToken は返されません。MaxResults の最大値は 100 です。
メソッド 2: PageSize を使用してページあたりの返されるエントリ数を設定し、PageNumber を使用してページ番号を設定します。

上記の 2 つのメソッドのいずれか 1 つのみを選択できます。large な数のエントリが返される場合、メソッド 1 を推奨します。MaxResults または NextToken パラメーターがセットされている場合、PageSize および PageNumber リクエストパラメーターは無効になります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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	任意	次のページをクエリするためのトークン。これ以上ページがない場合、このパラメーターは返されません。	NTxxxxxexample
MaxResults	integer	任意	ページネーションクエリのページあたりの行数。最大値: 100。	20
TargetType	string	任意	同期ターゲットタイプ。有効な値: identity_provider: ID プロバイダー 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	このリクエストによって返されたクエリトークン値。	NTxxxexample
SynchronizationJobs	array<object>	同期タスクのリスト。
	array<object>	同期タスクの詳細。
SynchronizationJobId	string	同期タスク ID。	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	同期ターゲットタイプ。有効な値: identity_provider: ID プロバイダー 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

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。