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

Descrição da operação

Antes de começar: Antes de chamar esta operação, ative o DataWorks Professional Edition ou uma edição superior. As edições Basic e Standard não suportam o recurso de coleção de metadados.

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

update

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CollectionQualifiedName	string	Sim	O identificador exclusivo da coleção.	album.2222
EntityQualifiedName	string	Sim	O identificador exclusivo da entidade.	maxcompute-table.projectA.tableB
Remark	string	Não	As observações sobre a entidade.	esta é uma observação

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	0000-ABCD-E****
Status	boolean	O resultado da operação. Valores válidos:\n\n- true: Bem-sucedido.\n- false: Falhou.	true
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	O produto especificado não existe
ErrorCode	string	O código de erro.	9999
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos:\n- true: A chamada foi bem-sucedida.\n- false: A chamada falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0000-ABCD-E****",
  "Status": true,
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified product does not exist",
  "ErrorCode": "9999",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Entity.NotExist	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.