ListMetaEntities - 查询元数据实体列表-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

查询元数据实体列表-当前仅支持纯自定义类型

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListMetaEntities

list

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
EntityType	string	是	实体类型	custom_entity-customer_api
MaxResults	integer	否	每页返回的最大结果数，默认为 10，最大 100	10
NextToken	string	否	下一页游标，首次请求不传，后续请求使用上一次返回的 NextToken	AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN
Name	string	否	实体名称过滤，关键词包含匹配	xm_create_test
Comment	string	否	注释过滤，分词匹配	this is a comment
AttributeFilters	array<object>	否	实体属性过滤条件，多个过滤条件之间为 AND 关系，同一过滤条件内多个值为 OR 关系	[]
	object	否	实体属性过滤
Key	string	是	过滤属性 Key	key1
Values	array	否	过滤属性值列表
	string	否	过滤属性值	value1
CustomAttributeFilters	array<object>	否	自定义属性过滤条件，多个过滤条件之间为 AND 关系，同一过滤条件内多个值为 OR 关系,仅支持 ENUM 自定义属性	[]
	object	否	自定义属性过滤
Key	string	是	过滤属性 Key	custom_attr_1
Values	array	否	过滤属性值列表
	string	否	过滤属性值	value1
SortBy	string	否	排序字段枚举值： ModifyTime : 按修改时间排序 CreateTime : 按创建时间排序 Name : 按名称排序	Name
Order	string	否	排序方向枚举值： Asc : 升序 Desc : 降序	Asc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS
Success	boolean	请求是否成功	true
PagingInfo	object	分页信息
TotalCount	integer	总数	10
MaxResults	integer	每页返回的最大结果数	10
NextToken	string	下一页游标	AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=
MetaEntities	array	自定义实体列表
	MetaEntity	自定义实体对象

示例

正常返回示例

JSON格式

{
  "RequestId": "ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "MaxResults": 10,
    "NextToken": "AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=",
    "MetaEntities": [
      {
        "Id": "custom_entity-customer_api:api_001",
        "EntityType": "custom_entity-customer_api",
        "Name": "api_001",
        "Comment": "this is a comment",
        "OwnerId": "207924799988354",
        "CustomAttributes": {
          "key": [
            "张三"
          ]
        },
        "MetaEntityDef": {
          "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
        },
        "CreateTime": 1780553640613,
        "ModifyTime": 1763380628000,
        "Attributes": {
          "key": "v1"
        }
      }
    ]
  }
}

错误码

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

变更历史

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