文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 数据建模引擎/ 结构化文档管理/ 获取Token信息 - ShowGetTokens
更新时间：2026-07-28 GMT+08:00
查看PDF
分享

获取Token信息 - ShowGetTokens

功能介绍

本接口用于通过文档ID和认证类型获取结构化文档的访问Token。获取Token后，可在Token有效期内对指定结构化文档进行只读或读写操作。

  • 当认证类型为read时，获取的Token仅支持对文档进行查看操作。

  • 当认证类型为write时，获取的Token支持对文档进行编辑、保存等操作。

接口约束

目标数据模型已在应用设计态配置了“结构化文档管理”功能。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

identifier

是

String

参数解释：

应用的唯一标识。

  • 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。

  • 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。

获取方法请参见获取运行服务清单 - ListEnvs。

约束限制：

不涉及。

取值范围：

  • 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

  • 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

modelName

是

String

参数解释：

数据模型的英文名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

applicationId

否

String

参数解释：

应用ID，用于指定实例所属的应用。

当URL路径中已能明确应用上下文时，此参数可不传。

获取方法请参见获取租户下的应用清单 - ListApps。

约束限制：

不涉及。

取值范围：

  • 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。

  • 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

params

是

GetTokenDto object

参数解释：

请求参数对象，包含文档ID和认证类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 GetTokenDto

参数

是否必选

参数类型

描述

auth_type

是

String

参数解释：

认证类型，指定获取Token的权限级别。

约束限制：

不涉及。

取值范围：

  • read：只读权限，获取的Token仅支持查看文档内容。

  • write：读写权限，获取的Token支持编辑和保存文档。

默认取值：

不涉及。

doc_id

是

String

参数解释：

文档ID，用于指定需要获取Token的目标文档。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释：

请求处理结果状态。

取值范围：

  • SUCCESS：请求成功。

  • FAIL：请求失败。

data

Array of GenerateTokenResultDto objects

参数解释：

请求数据，包含生成的Token及相关用户信息。

取值范围：

不涉及。

errors

Array of strings

参数解释：

异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。

取值范围：

不涉及。
表6 GenerateTokenResultDto

参数

参数类型

描述

token

String

参数解释：

认证Token，用于后续对结构化文档的访问鉴权。

取值范围：

不涉及。

user_id

String

参数解释：

用户ID，标识获取Token的IAM用户。

取值范围：

不涉及。

user_name

String

参数解释：

用户名，标识获取Token的IAM用户名称。

取值范围：

不涉及。

app_id

String

参数解释：

应用ID，用于指定实例所属的应用。

取值范围：

不涉及。

请求示例

示例：获取结构化文档的只读Token

获取文档ID为19619ac0-22ee-405a-bf35-53673efa3267的读权限Token信息。

POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_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，表示请求成功。

错误码

请参见错误码。

父主题： 结构化文档管理

相关文档