Queries the details of 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 GetMetaCollectionDetail

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

QualifiedName String Yes album.12345

The unique identifier of the collection.

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-E****

The ID of the request.
Collection Collection

The collection.
Success Boolean true

Indicates whether the request was successful. Valid values:

true: The request was successful.

false: The request failed.

ErrorCode String 9999

The error code returned.

ErrorMessage String album.xxxx does not exist.

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaCollectionDetail
&QualifiedName=album.12345
&<Common request parameters>

Sample success responses

XML format

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

<GetMetaCollectionDetailResponse>
    <RequestId>0000-ABCD-E****</RequestId>
    <Collection>
        <QualifiedName>album.12334</QualifiedName>
        <CollectionType>album</CollectionType>
        <Name>collectionName</Name>
        <Comment>comment</Comment>
        <OwnerId>1234444</OwnerId>
        <OwnerName>owner</OwnerName>
        <CreateTime>1668600147617</CreateTime>
        <UpdateTime>1668600148617</UpdateTime>
        <Level>1</Level>
    </Collection>
    <Success>true</Success>
    <ErrorCode>9999</ErrorCode>
    <ErrorMessage>album.xxxx does not exist.</ErrorMessage>
</GetMetaCollectionDetailResponse>

JSON format

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

{
  "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."
}

Error codes

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