Update a collection's name and comment using the UpdateMetaCollection API - DataWorks - Alibaba Cloud - DataWorks

Operation description

Only the Name and Comment fields can be updated.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
QualifiedName	string	Yes	The unique identifier of the collection.	album.396397
Name	string	No	The name of the collection.	myCollectionName
Comment	string	No	The comment of the collection. The comment must be 1 to 64 characters in length.	this is a comment

You must specify at least one of the Name and Comment parameters when you call this operation.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0000-ABCD-E****
Status	boolean	The result of the operation. Valid values: true false	true
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The returned message.	The specified product does not exist.
ErrorCode	string	The error code.	9999
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.