Todos os produtos
Search
Central de documentação

DataWorks:CreateCustomAttribute

Última atualização: Jun 26, 2026

Cria uma definição de atributo personalizado.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Id

string

Sim

O ID do atributo personalizado. O ID deve corresponder à expressão regular ^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$. A parte após `custom-attribute:` deve ter menos de 100 caracteres.

custom-attribute:biz_owner

DisplayName

string

Sim

O nome de exibição do atributo personalizado. O nome deve ter menos de 128 caracteres.

业务负责人

Type

string

Sim

O tipo do atributo personalizado. Valores válidos: ENUM, TEXT e HYPERLINK.

TEXT

EntityTypes

array

Sim

A lista de tipos de entidade aplicáveis. Você pode especificar tipos de entidade precisos ou usar curingas como *-table e *-column. Exemplos:

  • dataworks-project: um workspace do DataWorks.

  • dataworks-dataset: um dataset do DataWorks.

  • maxcompute-table: uma tabela do MaxCompute.

  • *-column: todos os tipos de campo.

string

Não

O tipo de entidade.

maxcompute-table

ValueEnums

array

Não

Os valores de enumeração. Este parâmetro é obrigatório quando `Type` é definido como `ENUM`. Não é suportado para os tipos TEXT e HYPERLINK.

string

Não

Os valores da enumeração.

VALUE_1

DisplayEnabled

boolean

Não

Especifica se o atributo deve ser exibido na página do produto. O valor padrão é true.

true

SearchFilterEnabled

boolean

Não

Especifica se o atributo pode ser usado como filtro na página de pesquisa do Data Map. O valor padrão é false. Atualmente, você pode definir este parâmetro como true apenas para atributos do tipo ENUM.

false

Comment

string

Não

A descrição do atributo personalizado. A descrição deve ter menos de 256 caracteres.

test comment

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Schema da resposta.

RequestId

string

O ID da solicitação.

5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

Result

boolean

O resultado da criação.

true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71",
  "Success": true,
  "Result": 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.