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

Executa uma consulta paginada nos ativos de dados do DataWorks associados a tags.

Descrição da operação

Você deve adquirir o DataWorks Enterprise Edition ou uma edição posterior para usar este recurso.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Tags	array<object>	Não	A lista de tags associadas aos ativos de dados. Este parâmetro é usado para filtrar os resultados da consulta com base nas tags:\n- Vários valores são avaliados com um operador lógico OR. Por exemplo, se você especificar `["key1:v1", "key2:v1", "key3:v1"]`, o sistema consulta os ativos de dados que contêm pelo menos uma das tags especificadas.\n- Se este parâmetro não for especificado ou for deixado vazio, nenhuma filtragem baseada em tags será realizada.
	object	Não	A definição do par chave-valor da tag.
Key	string	Não	A chave de tag personalizada inserida pelo usuário.\n\nA chave pode ter até 64 caracteres. Não pode começar com `dw:` e pode conter apenas letras, dígitos e os seguintes caracteres especiais: `-@#*<>\|[]()+=&%$!~`.	key
Value	string	Não	O valor da tag.	value
DataAssetIds	array	Não	A lista de IDs exclusivos dos ativos de dados.
	string	Não	O ID exclusivo do ativo de dados.	7000069357000
DataAssetType	string	Não	O tipo de ativo do ativo de dados.\n\n- Tabela do DataWorks (ACS::DataWorks::Table)\n\n- Tarefa agendada do DataWorks (ACS::DataWorks::Task) Valores válidos: ACS::DataWorks::Task : Tarefa do DataWorks. ACS::DataWorks::Table : Tabela do DataWorks.	ACS::DataWorks::Task
ProjectId	integer	Não	O ID do workspace.	10000
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
EnvType	string	Não	O ambiente do workspace ao qual o ativo de dados pertence. Valores válidos:\n- Dev: ambiente de desenvolvimento\n- Prod: ambiente de produção. Valores válidos: Prod : Ambiente de produção. Dev : Ambiente de desenvolvimento.	Prod
AssetDomainId	integer	Não	O ID do domínio do ativo.	1001
CategoryUuid	string	Não	O ID da categoria do ativo.	cate-xxxxxxxx
Name	string	Não	O nome do ativo. A pesquisa aproximada por nome é suportada.	Asset domain name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	0bc1ec92159376
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas.	100
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
DataAssets	array<object>	A lista de ativos de dados.
	array<object>	A definição de esquema do ativo de dados.
Id	string	O ID do ativo de dados.	7259557313
Name	string	O nome do ativo de dados.	ali_cn_es_gfn
Type	string	O tipo de ativo do ativo de dados.\n\n- Tabela do DataWorks (ACS::DataWorks::Table)\n\n- Tarefa agendada do DataWorks (ACS::DataWorks::Task)	ACS::DataWorks::Task
EnvType	string	O ambiente do workspace ao qual o ativo de dados pertence. Valores válidos:\n- Dev: ambiente de desenvolvimento\n- Prod: ambiente de produção.	Prod
ProjectId	integer	O ID do workspace do DataWorks.	54275
DataAssetTagMappings	array<object>	A lista de tags do ativo de dados.
	object	A definição de esquema da relação de mapeamento entre o ativo de dados e a tag.
Key	string	A chave da tag.	key
Value	string	O valor da tag.	value
TagSource	string	A origem da relação entre o ativo de dados e a tag. Valores válidos:\n\n- System: gerada por operações no sistema de governança de ativos de dados\n- UserDefined: definida manualmente pelo usuário.	UserDefined
Creator	string	O criador da relação de mapeamento entre o ativo de dados e a tag.	12345
AutoTraceEnabled	boolean	Especifica se o rastreamento automático de linhagem está ativado.	false
DataAssetId	string	O ID do ativo de dados.	7259557313
AssetCategories	array<object>	As informações da categoria do ativo.
	object	A categoria do ativo.
Id	string	O ID da categoria do ativo.	cate-xxxxxx
Name	string	O nome da categoria do ativo.	Asset domain name
AssetDomainId	string	O ID do domínio do ativo.	1001

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc1ec92159376",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "DataAssets": [
      {
        "Id": "7259557313",
        "Name": "ali_cn_es_gfn",
        "Type": "ACS::DataWorks::Task",
        "EnvType": "Prod",
        "ProjectId": 54275,
        "DataAssetTagMappings": [
          {
            "Key": "key",
            "Value": "value",
            "TagSource": "UserDefined",
            "Creator": "12345",
            "AutoTraceEnabled": false,
            "DataAssetId": "7259557313"
          }
        ],
        "AssetCategories": [
          {
            "Id": "cate-xxxxxx",
            "Name": "Asset domain name",
            "AssetDomainId": "1001"
          }
        ]
      }
    ]
  }
}

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.