UpdateColumnBusinessMetadata - DataWorks: Central de Documentação do Alibaba Cloud

Descrição da operação

Esta operação requer o DataWorks Basic Edition ou uma versão posterior.
Esta operação suporta apenas tabelas MaxCompute, hms e dlf.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:UpdateColumnBusinessMetadata

update

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID da coluna. Você pode obter este ID na resposta da operação ListColumns. Para mais informações, consulte Conceitos de Entidades de Metadados.	maxcompute-column:::project_name:[schema_name]:table_name:column_name
Description	string	Não	A descrição de negócio da coluna.	test description
CustomAttributes	object	Não	Os atributos personalizados da coluna, especificados como pares chave-valor. A chave é o identificador do atributo e o valor é um array que pode conter no máximo um elemento. Um array vazio exclui o valor do atributo. Quando Description é omitido, o fornecimento deste parâmetro pode impedir que a descrição de negócio da coluna seja limpa. Um objeto vazio ({}) indica que nenhum atributo personalizado é atualizado.	{"biz_owner":["Zhang San"]}
	array	Não	Um array que contém o valor do atributo personalizado. Este array pode conter no máximo um elemento.
	string	Não	O valor do atributo.	Zhang San

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.