All Products
Search

This Product

    DataWorks:UpdateTableBusinessMetadata

    Document Center

    DataWorks:UpdateTableBusinessMetadata

    Last Updated:Jan 12, 2026

    Updates the business metadata of a table in Data Map. Currently, only the usage notes of a table 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
    IdstringYes

    The table ID. You can refer to the format of the table ID returned by the ListTables operation.

    		maxcompute-table:123456XXX::test_project::test_tbl dlf-table:123456XXX:test_catalog:test_db::test_tbl hms-table:c-abc123xxx::test_db::test_tbl holo-table:h-abc123xxx::test_db:test_schema:test_tbl
    ReadmestringNo

    The usage notes. The rich text format is supported.

    		## introduction

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    Request ID.

    		7C352CB7-CD88-XXXXXXX
    Successboolean

    Indicates whether the request was successful.

    		true

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "7C352CB7-CD88-XXXXXXX",
  "Success": true
}

    Error codes

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