All Products
Search
Document Center

DataWorks:UpdateMetaCollection

Last Updated:Oct 17, 2024

Updates the name and comment of a collection.

Operation description

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

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.396397
NamestringNo

The name of the collection.

myCollectionName
CommentstringNo

The comment of the collection. The comment must be 1 to 64 characters in length.

this is a comment

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

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

0000-ABCD-E****
Statusboolean

The result of the operation. Valid values: true false

true
HttpStatusCodeinteger

The HTTP status code.

200
ErrorMessagestring

The returned message.

The specified product does not exist.
ErrorCodestring

The error code.

9999
Successboolean

Indicates whether the request was successful. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "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, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history