全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListMetaCollectionEntities

更新时间:Aug 09, 2023

查询集合中的实体

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListMetaCollectionEntities

系统规定参数。取值:ListMetaCollectionEntities

CollectionQualifiedName String album.12345

集合唯一标识

EntityType String maxcompute-table

实体类型

例如: maxcompute-table : maxcompute 表类型

Keyword String test

搜索关键词

NextToken String 12222

分页信息,指定本次读取的起始点

PageSize Integer 10

分页大小

返回数据

名称

类型

示例值

描述

Data Object

返回结构体

NextToken String 123344

下一页的token

EntityList Array of Entity

实体数组

RequestId String E25887B7-579C-54A5-9C4F-83A0DE367DD

请求的ID。用于定位日志,排查问题。

Success Boolean true

调用是否成功。取值如下:

true:调用成功。

false:调用失败。

ErrorCode String Invalid.Collection.NotExists

错误码。

ErrorMessage String The specified parameters are invalid.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

示例

请求示例

http(s)://[Endpoint]/?Action=ListMetaCollectionEntities
&CollectionQualifiedName=album.12345
&EntityType=maxcompute-table
&Keyword=test
&NextToken=12222
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListMetaCollectionEntitiesResponse>
    <Data>
        <NextToken>12</NextToken>
        <EntityList>
            <EntityContent>
                <entityType>maxcompute-table</entityType>
                <name>table_name_for_example</name>
                <projectName>maxcomputeProjectName</projectName>
                <remark>cui</remark>
                <addToCollectionTimestamp>1691563804264</addToCollectionTimestamp>
            </EntityContent>
            <QualifiedName>maxcompute-table.maxcomputeProjectName.table_name_for_example</QualifiedName>
        </EntityList>
    </Data>
    <RequestId>E25887B7-579C-54A5-9C4F-83A0DE367DD</RequestId>
    <Success>true</Success>
    <ErrorCode>Invalid.Collection.NotExists</ErrorCode>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <HttpStatusCode>200</HttpStatusCode>
</ListMetaCollectionEntitiesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "NextToken" : "12",
    "EntityList" : [ {
      "EntityContent" : {
        "entityType" : "maxcompute-table",
        "name" : "table_name_for_example",
        "projectName" : "maxcomputeProjectName",
        "remark" : "cui",
        "addToCollectionTimestamp" : "1691563804264"
      },
      "QualifiedName" : "maxcompute-table.maxcomputeProjectName.table_name_for_example"
    } ]
  },
  "RequestId" : "E25887B7-579C-54A5-9C4F-83A0DE367DD",
  "Success" : true,
  "ErrorCode" : "Invalid.Collection.NotExists",
  "ErrorMessage" : "The specified parameters are invalid.",
  "HttpStatusCode" : 200
}

返回示例补充说明

addToCollectionTimestamp:  时间戳(毫秒)

错误码

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