ListMetaEntityDefs - 查询元数据实体定义列表 - 大数据开发治理平台 DataWorks

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListMetaEntityDefs

list

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	分页页码，默认为 1	1
PageSize	integer	否	分页大小，默认为 10，最大 100	10
DisplayName	string	否	类型定义展示名称，按普通文本包含匹配	CustomReport
Description	string	否	描述，模糊匹配	description
Extend	string	否	扩展模式过滤，支持 NONE、TABLE 枚举值： TABLE : 扩展表实体 NONE : 纯自定义实体	TABLE
SortBy	string	否	排序字段，支持 Name、CreateTime、ModifyTime 枚举值： ModifyTime : 按修改时间排序 CreateTime : 按创建时间排序 Name : 按名称排序	CreateTime
Order	string	否	排序方向，支持 Asc、Desc 枚举值： Asc : 升序 Desc : 降序	Asc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	请求是否成功	true
PagingInfo	object	分页信息
TotalCount	integer	总数	10
PageNumber	integer	分页页码	1
PageSize	integer	分页大小	10
MetaEntityDefs	array	自定义实体定义列表
	MetaEntityDef	自定义实体定义

示例

正常返回示例

JSON格式

{
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "MetaEntityDefs": [
      {
        "Name": "biz_api",
        "EntityType": "custom_entity-biz_api",
        "DisplayName": "业务API",
        "Description": "test",
        "AttributeDefs": [
          {
            "Name": "apiCode",
            "DisplayName": "API编码",
            "Type": "STRING",
            "IsOptional": true,
            "SearchFilterEnabled": false,
            "DisplayEnabled": true,
            "AllowedValues": [
              "LABEL_1"
            ],
            "Description": "层级描述"
          }
        ],
        "Extend": "NONE",
        "CreateTime": 1780553640613,
        "ModifyTime": 1780553640613
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。