Updates a collection.

Only the name and comment of a collection can be updated.

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 UpdateMetaCollection

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

QualifiedName String Yes album.396397

The unique identifier of the collection.
Name String No myCollectionName

The name of the collection.
Comment String No this is a comment

The comment of the collection.

The comment must be 1 to 64 characters in length.

You must configure at least one of the Name and Comment parameters when you update a collection.

Response parameters

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

The ID of the request. You can use the ID to query logs and troubleshoot issues.

Status Boolean true

The result of the operation. Valid values:

true: succeeded

false: failed
HttpStatusCode Integer 200

The HTTP status code returned.

ErrorMessage String The specified product does not exist.

The error message returned.

ErrorCode String 9999

The error code returned.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateMetaCollection
&QualifiedName=album.396397
&Name=myCollectionName
&Comment=this is a comment
&<Common request parameters>

Sample success responses

XML format

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

<UpdateMetaCollectionResponse>
    <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>
</UpdateMetaCollectionResponse>

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.