统一目录实体类型详情¶

GET /api/v1/unified_catalog/entity_type_cfg/get

概述¶

获取单个统一目录实体类型详情。

Query 请求参数¶

参数名	类型	必选	说明
entityTypeUUID	string		实体类型 UUID；传 default 时返回自定义实体类型创建模板允许为空: False
entityType	string		实体类型编码允许为空: False

参数补充说明¶

请求参数说明

参数名	type	必选	说明
entityTypeUUID	string	否	实体类型 UUID
entityType	string	否	实体类型编码

调用注意事项

entityTypeUUID 与 entityType 至少传一个。
entityTypeUUID=default 时返回自定义实体类型创建模板，该模板为 status=3 数据，不会出现在实体类型列表中。
若两个参数都传，建议保证它们指向同一个实体类型。
返回结果包含 schemaDefine、viewDefine、extraConfig。
返回当前工作空间的 customProperties 和合并后的 effectiveSchemaDefine。

请求例子¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/get?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

响应¶

{
    "code": 200,
    "content": {
        "uuid": "sys_service",
        "entityType": "service",
        "name": "服务",
        "schemaDefine": "yaml text",
        "viewDefine": "yaml text",
        "extraConfig": {},
        "customProperties": "custom_properties:\\n  - name: business_owner\\n    type: string\\n",
        "effectiveSchemaDefine": "yaml text"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}