更新时间:2025-11-13 GMT+08:00
分享

查询管理联邦任务结果 (queryTask)

场景描述

查询管理联邦任务结果。

接口方法

POST

接口URI

https://域名/apiaccess/rest/cc-management/v1/federationUserMgmt/queryTask,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

True

appKey字段,用户标识

2

Authorization

string

True

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

requestBody

object

True

查询管理联邦任务结果的请求信息。

1.1

taskId

string

True

查询任务ID。

表3中返回的taskId的值。

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    是否必选

    说明

    1

    schema

    object

    True

    响应消息。

    1.1

    resultCode

    string

    True

    返回码。

    • 0:成功
    • 其他的表示失败,详情请参见表5

    1.2

    resultMessage

    string

    False

    返回结果描述信息。

    1.3

    taskInfo

    object

    False

    任务信息

    1.3.1

    status

    string

    False

    任务状态:

    • TODO
    • DOING
    • DONE

    1.3.2

    remark

    string

    False

    任务备注描述。

    1.4

    failDataList

    array[object]

    False

    失败数据列表。

    1.4.1

    federationUser

    object

    False

    联邦用户信息。

    1.4.1.1

    action

    string

    False

    操作类型:

    • CREATE
    • MODIFY
    • DISABLE

    1.4.1.2

    userName

    string

    False

    联邦用户名。

    1.4.1.3

    userAccount

    string

    False

    联邦用户账号。

    1.4.1.4

    email

    string

    False

    联邦用户邮箱。

    1.4.1.5

    roleIds

    array

    False

    分配给此联邦用户的角色ID列表。

    1.4.2

    failCode

    string

    False

    失败原因码,详情请参见表4

    1.4.3

    failMessage

    string

    False

    失败原因信息。

    表4 failCode描述信息

    failCode

    描述

    60101040050

    输入的参数({param})不合法,不合法描述:{desc}

    60101060003

    映射失败。

    60101060007

    联邦用户不存在。

    60101030013

    传入的角色标识({roleId})在数据库中不存在。

    60101900002

    系统内部错误,具体原因:{detail}

    60101000100

    获取用户详细信息失败。

    60101000101

    获取联邦用户映射规则失败。

    60101000102

    获取第三方系统标识信息失败。

    60101000103

    获取用户详细信息为空。

    60101000104

    调用sum接口获取用户角色信息失败。

    60101000105

    创建用户获取的用户id为空。

    60101000108

    租间已存在该用户。

    60101000109

    联邦用户映射规则与输入参数映射失败

    6010104157

    该登录账号({userAccount})已存在。

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

表5 错误码

错误码

描述

100-111

taskId超过长度限制或者不是数字

100-112

该taskid查询不到联邦用户任务

报文样例

请求头:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json

请求参数:

{
  "taskId": "1659446191820726274"
 }

响应参数:

{
     "failDataList": [],
     "resultCode": "0",
     "taskInfo": {
         "remark": "",
         "status": "DONE"
     },
     "resultMessage": "The query is successful."
 }

相关文档