All Products
Search
Document Center

DataWorks:UpdateMetaTable

Last Updated:Oct 17, 2024

Updates the metadata information about a table.

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
ProjectIdlongYes

The DataWorks workspace ID.

101
TableNamestringYes

The name of the table.

table1
EnvTypeintegerYes

The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.

1
TableGuidstringNo

The GUID of the table. Specify the GUID in the format of odps.{projectName}.{tableName}.

odps.test.table1
NewOwnerIdstringNo

The new owner ID. If you leave this parameter empty, the owner ID is not updated.

12345
AddedLabelsstringNo

The names of the labels that you want to add. Separate the labels with commas (,).

a,b,c
RemovedLabelsstringNo

The names of labels that you want to remove. Separate the labels with commas (,).

a,b,c
CategoryIdlongNo

The ID of the category that you want to associate.

101
VisibilityintegerNo

The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all members. The value 1 indicates that the table is visible to all members. The value 2 indicates that the table is visible to workspace members.

1
CaptionstringNo

The display name of the table.

test
SchemastringNo

The schema information about the table. You must configure this parameter if you enable the three-layer model of MaxCompute.

default

Response parameters

ParameterTypeDescriptionExample
object
UpdateResultboolean

Indicates whether the metadata information about the table was updated.

true
RequestIdstring

The request ID.

abcde

Examples

Sample success responses

JSONformat

{
  "UpdateResult": true,
  "RequestId": "abcde"
}

Error codes

HTTP status codeError codeError messageDescription
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

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

Change history

Change timeSummary of changesOperation
No change history