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

Obtém uma lista de componentes.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior 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:ListComponents

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace associado à fonte de dados. Você pode chamar a operação ListProjects para obter o ID do workspace.	100001
Name	string	Não	O nome da fonte de dados.	xm_create_test
PageNumber	integer	Não	O número da página para paginação.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	1000

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação. Use este ID para solução de problemas.	952795279527ab****
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
Components	array<object>	O UID do usuário que criou o componente de aceleração do conjunto de dados. No Alibaba Cloud, este é o ID de usuário do RAM (ou o ID da conta do Alibaba Cloud se criado pela própria conta).
	array<object>	O UID do usuário que criou o componente de aceleração do conjunto de dados. No Alibaba Cloud, este é o ID de usuário do RAM (ou o ID da conta do Alibaba Cloud se criado pela própria conta).
ModifyTime	string	O timestamp em que o processo de implantação foi modificado.	2023-11-30T13:30:58Z
Script	object	As informações do script.
Path	string	O caminho do script.	/
Runtime	object	O runtime.
Command	string	O comando.	SQL_COMPONENT
Id	string	ID	348100
Owner	string	O proprietário.	252675537980665607
Description	string	A descrição.	vpc peering management_staging
CreateTime	string	A hora de criação.	2023-03-13 16:35:59
Outputs	array<object>	Os parâmetros de saída.
	object	A saída do nó.
DefaultValue	string	O valor padrão.	32000
Type	string	O tipo de parâmetro.	string
Description	string	A descrição do parâmetro.	zdy
Name	string	O nome do parâmetro.	auto_updateAlertRule_test_bULIRo
ProjectId	integer	O ID do workspace do DataWorks. Para obter o ID do workspace, faça login no console do DataWorks e navegue até a página de configuração do workspace. Você deve especificar este parâmetro ou ProjectIdentifier para identificar o workspace do DataWorks de destino para esta chamada de API.	199925
ComponentId	string	O ID do componente. Este parâmetro pode ser usado em solicitações para consultar, modificar ou excluir componentes do diretor.	12312313123
Inputs	array<object>	Os parâmetros de entrada.
	object	O elemento da variável.
DefaultValue	string	O valor padrão da variável.	mdb.shard.2x.2xlarge.d
Type	string	O tipo de parâmetro.	string
Description	string	A descrição do parâmetro.	None
Name	string	O nome do parâmetro.	auto_updateAlertRule_test_bULIRo
Name	string	O nome do recurso.	auto_updateAlertRule_test_lJd81f

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "952795279527ab****",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Components": [
      {
        "ModifyTime": "2023-11-30T13:30:58Z",
        "Script": {
          "Path": "/",
          "Runtime": {
            "Command": "SQL_COMPONENT"
          },
          "Id": "348100"
        },
        "Owner": "252675537980665607",
        "Description": "vpc peering management_staging",
        "CreateTime": "2023-03-13 16:35:59",
        "Outputs": [
          {
            "DefaultValue": "32000",
            "Type": "string",
            "Description": "zdy",
            "Name": "auto_updateAlertRule_test_bULIRo"
          }
        ],
        "ProjectId": 199925,
        "ComponentId": "12312313123",
        "Inputs": [
          {
            "DefaultValue": "mdb.shard.2x.2xlarge.d",
            "Type": "string",
            "Description": "None",
            "Name": "auto_updateAlertRule_test_bULIRo"
          }
        ],
        "Name": "auto_updateAlertRule_test_lJd81f"
      }
    ]
  }
}

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.