All Products
Search
Document Center

DataWorks:AddMetaCollectionEntity

Last Updated:Aug 10, 2023

Adds an entity to 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 AddMetaCollectionEntity

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

CollectionQualifiedName String Yes album.2222

The unique identifier of the collection.

EntityQualifiedName String Yes maxcompute-table.projectA.tableB

The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.

Remark String No this is a remark

The remarks on the entity. Example: latest product table.

Response parameters

Parameter

Type

Example

Description

RequestId String 0000-ABCD-E****

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

Status Boolean true

The result of the operation. Valid values:

  • true: succeeded
  • false: failed
HttpStatusCode Integer 200

The HTTP status code.

ErrorMessage String The specified product does not exist.

The error message.

ErrorCode String 9999

The error code.

Success Boolean true

Indicates whether the request was successful. Valid values:

true false

Examples

Sample requests

http(s)://[Endpoint]/?Action=AddMetaCollectionEntity
&CollectionQualifiedName=album.2222
&EntityQualifiedName=maxcompute-table.projectA.tableB
&Common request parameters

Sample success responses

XML format

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

<AddMetaCollectionEntityResponse>
    <RequestId>0000-ABCD-E****</RequestId>
    <Status>true</Status>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The specified product does not exist.</ErrorMessage>
    <ErrorCode>9999</ErrorCode>
    <Success>true</Success>
</AddMetaCollectionEntityResponse>

JSON format

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

{
  "RequestId" : "0000-ABCD-E****",
  "Status" : true,
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The specified product does not exist.",
  "ErrorCode" : "9999",
  "Success" : true
}

Error codes

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