查询同步任务状态接口

将 <BASE_URL> 替换为所在企业环境的 API 域名。

  • Scope:admin.v1.directory-sync-runs.read
  • 权限项:用户同步任务读取(directory-sync-runs)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/directory-sync/runs/{runId}

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。

名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
runIdpathstring · uuid必填-"<uuid>"

请求示例

cURL

curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/directory-sync/runs/<runId>' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
runOpenapifacadeDirectorySyncRun是-{"created_at":"2026-08-27T10:00:00Z","error_code":"<string>","error_summary":"<string>","finished_at":"2026-08-27T10:00:00Z","id":"<uuid>","requested_by_email":"<string>","requested_by_name":"<string>","resource_type":"<string>","result":"success","source_id":"<uuid>","source_name":"<string>","source_type":"<string>","started_at":"2026-08-27T10:00:00Z","stats":{"departments":{"created":0,"deactivated":0,"deleted":0,"updated":0},"failed":0,"processed":0,"relationships":{"added":0,"removed":0,"returned_to_root":0},"seats":{"granted":0,"reclaimed":0},"succeeded":0,"users":{"created":0,"deactivated":0,"deleted":0,"updated":0}},"status":"pending","trigger_type":"manual"}
run.created_atstring · date-time是-"2026-08-27T10:00:00Z"
run.error_codestring否-"<string>"
run.error_summarystring否-"<string>"
run.finished_atstring · date-time否-"2026-08-27T10:00:00Z"
run.idstring · uuid是-"<uuid>"
run.requested_by_emailstring否-"<string>"
run.requested_by_namestring否-"<string>"
run.resource_typestring是-"<string>"
run.resultstring否-"success"
run.source_idstring · uuid是-"<uuid>"
run.source_namestring是-"<string>"
run.source_typestring是-"<string>"
run.started_atstring · date-time否-"2026-08-27T10:00:00Z"
run.statsOpenapifacadeDirectorySyncRunStats是-{"departments":{"created":0,"deactivated":0,"deleted":0,"updated":0},"failed":0,"processed":0,"relationships":{"added":0,"removed":0,"returned_to_root":0},"seats":{"granted":0,"reclaimed":0},"succeeded":0,"users":{"created":0,"deactivated":0,"deleted":0,"updated":0}}
run.stats.departmentsOpenapifacadeDirectorySyncChangeCounts是-{"created":0,"deactivated":0,"deleted":0,"updated":0}
run.stats.departments.createdinteger · int64是-0
run.stats.departments.deactivatedinteger · int64否-0
run.stats.departments.deletedinteger · int64是-0
run.stats.departments.updatedinteger · int64是-0
run.stats.failedinteger · int64否-0
run.stats.processedinteger · int64否-0
run.stats.relationshipsOpenapifacadeDirectorySyncRelationshipCounts是-{"added":0,"removed":0,"returned_to_root":0}
run.stats.relationships.addedinteger · int64是-0
run.stats.relationships.removedinteger · int64是-0
run.stats.relationships.returned_to_rootinteger · int64是-0
run.stats.seatsOpenapifacadeDirectorySyncSeatCounts是-{"granted":0,"reclaimed":0}
run.stats.seats.grantedinteger · int64是-0
run.stats.seats.reclaimedinteger · int64是-0
run.stats.succeededinteger · int64否-0
run.stats.usersOpenapifacadeDirectorySyncChangeCounts是-{"created":0,"deactivated":0,"deleted":0,"updated":0}
run.stats.users.createdinteger · int64是-0
run.stats.users.deactivatedinteger · int64否-0
run.stats.users.deletedinteger · int64是-0
run.stats.users.updatedinteger · int64是-0
run.statusstring是-"pending"
run.trigger_typestring是-"manual"

响应示例

{
  "run": {
    "created_at": "2026-08-27T10:00:00Z",
    "error_code": "<string>",
    "error_summary": "<string>",
    "finished_at": "2026-08-27T10:00:00Z",
    "id": "<uuid>",
    "requested_by_email": "<string>",
    "requested_by_name": "<string>",
    "resource_type": "<string>",
    "result": "success",
    "source_id": "<uuid>",
    "source_name": "<string>",
    "source_type": "<string>",
    "started_at": "2026-08-27T10:00:00Z",
    "stats": {
      "departments": {
        "created": 0,
        "deactivated": 0,
        "deleted": 0,
        "updated": 0
      },
      "failed": 0,
      "processed": 0,
      "relationships": {
        "added": 0,
        "removed": 0,
        "returned_to_root": 0
      },
      "seats": {
        "granted": 0,
        "reclaimed": 0
      },
      "succeeded": 0,
      "users": {
        "created": 0,
        "deactivated": 0,
        "deleted": 0,
        "updated": 0
      }
    },
    "status": "pending",
    "trigger_type": "manual"
  }
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否-{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring否Request field that failed validation"<string>"
details.reasonstring否Stable validation failure reason"<string>"
details.suggestionstring否Suggested normalized value"<string>"
errorstring是Stable HTTP error type"<string>"

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}