All Products
Search
Document Center

:ListMetaCollectionEntities

更新時間:May 09, 2024

Queries the entities in a collection.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

ListMetaCollectionEntities

The operation that you want to perform. Set the value to ListMetaCollectionEntities.

CollectionQualifiedName

String

Yes

album.12345

The unique identifier of the collection.

EntityType

String

No

maxcompute-table

The type of the entities.

For example, if this parameter is set to maxcompute-table, the entity is a MaxCompute table.

Keyword

String

No

test

The search keyword.

NextToken

String

No

12222

The pagination token that is used in the next request to retrieve a new page of results.

PageSize

Integer

No

10

The number of entries per page.

Response parameters

Parameter

Type

Example

Description

Data

Object

The response parameters.

NextToken

String

123344

The pagination token that is used in the next request to retrieve a new page of results.

EntityList

Array of Entity

The entities.

RequestId

String

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

The request ID. You can locate logs and troubleshoot issues based on the ID.

Success

Boolean

true

Indicates whether the request was successful. Valid values:

true

false

ErrorCode

String

Invalid.Collection.NotExists

The error code returned.

ErrorMessage

String

The specified parameters are invalid.

The error message returned.

HttpStatusCode

Integer

200

The HTTP status code returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListMetaCollectionEntities
&CollectionQualifiedName=album.12345
&EntityType=maxcompute-table
&Keyword=test
&NextToken=12222
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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 format

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
}

Additional description of sample responses

addToCollectionTimestamp: a timestamp, in milliseconds.

Error codes

For a list of error codes, see Service error codes.