GetSynchronizationJob API リファレンス - IDaaS

単一の同期ジョブに関する情報を取得します。

今すぐお試しください

この 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:GetSynchronizationJob

get

*SynchronizationJob

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
SynchronizationJobId	string	必須	同期ジョブの ID。	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJob	object	同期ジョブに関する情報。
SynchronizationJobId	string	同期ジョブの ID。	sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx
TargetType	string	同期先のタイプ。有効な値： identity_provider application	identity_provider
TargetId	string	同期先の ID。	idp_my664lwkhpicbyzirog3nxxxxx
Direction	string	同期ジョブの方向。有効な値： ingress egress	ingress
StartTime	integer	同期の開始時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。	1649830226000
EndTime	integer	同期の終了時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。	1649830226000
TriggerType	string	同期のトリガータイプ。有効な値： auto manual	auto
Status	string	同期ジョブのステータス。有効な値： pending running failed partial_success success	running
Result	object	同期ジョブの結果。
UserStatistics	object	ユーザー同期結果の統計。
Created	object	作成結果の統計。
Total	integer	項目の総数。	10
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Updated	object	更新結果の統計。
Total	integer	項目の総数。	10
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Binded	object	バインド結果の統計。
Total	integer	項目の総数。	10
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Deleted	object	削除結果の統計。
Total	integer	項目の総数。	10
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Same	object	同一ユーザーに関する結果の統計。
Total	integer	項目の総数。	10
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Pushed	object	通知結果の統計。
Total	integer	項目の総数。	10
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
OrganizationalUnitStatistics	object	組織部門の同期結果の統計。
Created	object	作成結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Updated	object	更新結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Binded	object	バインド結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Deleted	object	削除結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Same	object	同一組織部門に関する結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Pushed	object	通知結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
GroupStatistics	object	グループ同期結果の統計。
Created	object	作成結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Updated	object	更新結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Binded	object	バインド結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Deleted	object	削除結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Same	object	同一グループに関する結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Pushed	object	通知結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
GroupMemberStatistics	object	グループメンバー同期結果の統計。
Created	object	作成結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Updated	object	更新結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Binded	object	バインド結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Deleted	object	削除結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Same	object	同一グループメンバーに関する結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
Pushed	object	通知結果の統計。
Total	integer	項目の総数。	30
Success	integer	成功した項目の数。	10
Failed	integer	失敗した項目の数。	10
Skipped	integer	スキップされた項目の数。	10
ErrorMessage	string	エラーが発生した場合に返されるエラーメッセージ。	内部错误
ErrorCode	string	エラーメッセージに対応するエラーコード。	ErrorCodeNotFound

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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