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

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

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:CreateCustomAttribute

create

*Todos os recursos.

*

Nenhuma

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 valor deve corresponder a `^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 valor deve ter menos de 128 caracteres.	BusinessOwner
Type	string	Sim	O tipo do atributo personalizado. Valores válidos: ENUM, TEXT e HYPERLINK. Valores válidos: ENUM : Tipo de enumeração. HYPERLINK : Tipo de hiperlink. TEXT : Tipo de texto.	TEXT
EntityTypes	array	Sim	A lista de tipos de entidade aplicáveis. Tipos exatos de entidade e padrões curinga como `-table` e `-column` são suportados. Exemplos:\n- dataworks-project: workspace\n- dataworks-dataset: conjunto de dados do DataWorks\n- maxcompute-table: tabela do MaxCompute\n- *-column: todos os tipos de coluna.
	string	Não	O tipo de entidade.	maxcompute-table
ValueEnums	array	Não	Os valores de enumeração. Este parâmetro é obrigatório quando o tipo é definido como ENUM. Este parâmetro não é suportado para os tipos TEXT ou HYPERLINK.
	string	Não	O valor de enumeração.	VALUE_1
DisplayEnabled	boolean	Não	Especifica se o atributo deve ser exibido na página de detalhes. Valor padrão: true.	true
SearchFilterEnabled	boolean	Não	Especifica se o atributo pode ser usado como condição de filtro na página de busca do Mapa de Dados do DataWorks. Valor padrão: false. Atualmente, apenas o tipo ENUM suporta a definição deste valor como true.	false
Comment	string	Não	A descrição do atributo personalizado. O valor deve ter menos de 256 caracteres.	test comment

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema 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.