更新时间:2025-02-24 GMT+08:00
分享

获取Token信息

功能介绍

该接口可以用于通过文档ID和认证类型的方式进行认证来获取结构化文档的Token。

接口约束

功能列表勾选了结构化文档管理的模型可以使用该接口。

URI

POST /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/tokens

表1 路径参数

参数

是否必选

参数类型

描述

identifier

String

参数解释:

应用唯一标识。

约束限制:

不涉及。

取值范围:

由英文字母和数字组成,且长度为32个字符。

默认取值:

不涉及。

modelName

String

参数解释:

数据模型的英文名称。

约束限制:

不涉及。

取值范围:

大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

IAM用户的token。

获取方法请参见获取IAM用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

String

参数解释

应用ID。

约束限制

不涉及。

取值范围

由英文字母和数字组成,且长度为32个字符。

默认取值

不涉及。

params

GetTokenDto object

参数解释:

请求参数对象。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 GetTokenDto

参数

是否必选

参数类型

描述

auth_type

String

参数解释

认证类型。

约束限制

不涉及。

取值范围

  • read:只读。

  • write:读写。

默认取值

不涉及。

doc_id

String

参数解释

文档ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释:

请求结果。

取值范围:

  • SUCCESS:请求成功。

  • FAIL:请求失败。

默认取值:

不涉及。

data

Array of GenerateTokenResultDto objects

参数解释:

请求数据。

取值范围:

不涉及。

默认取值:

不涉及。

errors

Array of strings

参数解释:

异常信息。

取值范围:

不涉及。

默认取值:

不涉及。

表6 GenerateTokenResultDto

参数

参数类型

描述

token

String

参数解释

认证token。

取值范围

不涉及。

默认取值

不涉及。

user_id

String

参数解释

用户ID。

取值范围

不涉及。

默认取值

不涉及。

user_name

String

参数解释

用户名。

取值范围

不涉及。

默认取值

不涉及。

app_id

String

参数解释

应用ID。

取值范围

不涉及。

默认取值

不涉及。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/structured-doc/tokens

{
  "params" : {
    "auth_type" : "read",
    "doc_id" : "19619ac0-22ee-405a-bf35-53673efa3267"
  }
}

响应示例

状态码:200

OK

{
  "result" : "SUCCESS",
  "data" : [ {
    "token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ7XCJ1c2VyTmFtZVwiOlwiWERNX0RldmVsb3BlclwiLFwiYXV0aFR5cGVcIjpcIjFcIixcInVzZXJJZFwiOlwiOTMxNzJiYmZkMGY2NDQzNzk1NmQ0YzlkZTkzNDUzODZcIn0iLCJkb2MiOiJ7XCJkb2N1bWVudElkXCI6XCIxOTYxOWFjMC0yMmVlLTQwNWEtYmYzNS01MzY3M2VmYTMyNjdcIn0iLCJleHAiOjE3MzY5NDg5MjR9.7VdVR6lpErzKdpqVvre_Yj2OWtQ86dzrbhtAi0d50DE",
    "user_id" : "93172bbfd0f64437956d4c9de9345386",
    "user_name" : "XDM_Developer",
    "app_id" : "20240910111314182-0683-5DD122D41"
  } ],
  "errors" : [ ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档