All Products
Search
Document Center

DataWorks:GetMetaCollectionDetail

Last Updated:Oct 17, 2024

Queries the information about a collection.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
QualifiedNamestringYes

The unique identifier of the collection.

album.12345

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

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

0000-ABCD-E****
CollectionCollection

The information about the collection.

Successboolean

Indicates whether the request was successful. Valid values:

true

false

true
ErrorCodestring

The error code.

9999
ErrorMessagestring

The error message.

album.xxxx does not exist.
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-E****",
  "Collection": {
    "QualifiedName": "album.12334",
    "CollectionType": "album",
    "Name": "collectionName",
    "Comment": "comment",
    "OwnerId": "1234444",
    "OwnerName": "owner",
    "CreateTime": 1668600147617,
    "UpdateTime": 1668600148617,
    "Level": 1
  },
  "Success": true,
  "ErrorCode": "9999",
  "ErrorMessage": "album.xxxx does not exist.",
  "HttpStatusCode": 200
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history