文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 公共资源API/ 字典管理/ 校验字典是否存在 - ValidateDictionary
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

校验字典是否存在 - ValidateDictionary

功能介绍

校验指定条件的字典是否存在，支持字典名称和字典编码。

授权信息

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

URI

GET /v2/{project_id}/instances/{instance_id}/validate-dictionaries

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

待校验是否重复的字典名称，精确匹配。

code

否

String

待校验是否重复的字典编码，精确匹配。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

name

String

字典名称。

  • 字符集：中文、英文字母、数字、下划线和空格。

  • 约束：实例下唯一。

code

String

字典编码。

  • 字符集：英文字母、数字、下划线和空格。

  • 约束：实例下唯一。

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

error_details

String

具体错误消息。

request_id

String

请求处理ID。

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

error_details

String

具体错误消息。

request_id

String

请求处理ID。

请求示例

无

响应示例

状态码：200

OK

{
  "name" : "MyDict",
  "code" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3"
}

状态码：403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码：404

Not Found

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码

状态码

描述

200

OK

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 字典管理