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

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta operação.

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

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TableId	string	Sim	O ID da tabela. Você pode obter o ID na resposta da operação ListTables. Para mais informações, consulte Conceitos relacionados a entidades de metadados.	maxcompute-table:::project_name:[schema_name]:table_name
Name	string	Não	O nome da coluna. Há suporte para correspondência aproximada.	test_table
Comment	string	Não	O comentário sobre a coluna. Há suporte para correspondência aproximada.	test comment
SortBy	string	Não	O campo usado para ordenação. Valor padrão: Position. Valores válidos: Name: Nome. Position: Posição. Valores válidos: Position : Posição. Name : Nome.	Position
Order	string	Não	A ordem de classificação. Valor padrão: Asc. Valores válidos: Asc: Ordem ascendente. Desc: Ordem descendente. Valores válidos: Asc : Ordem ascendente. Desc : Ordem descendente.	Asc
PageNumber	integer	Não	O número da página. 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
IncludeExtendedProperties	boolean	Não	Especifica se as propriedades estendidas devem ser retornadas. Se você definir este parâmetro como true, as propriedades estendidas serão retornadas. Se você definir este parâmetro como false, as propriedades estendidas não serão retornadas.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
PagingInfo	object	As informações de paginação.
Columns	array	A lista de colunas.
	Column	As informações da coluna.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
TotalCount	integer	O número total de entradas.	1
RequestId	string	O ID da solicitação.	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "PagingInfo": {
    "Columns": [
      {
        "BusinessMetadata": {
          "CustomAttributes": {
            "key": [
              "Zhang San"
            ]
          },
          "Description": "Business description of Column 1"
        },
        "Comment": "Column 1",
        "ForeignKey": false,
        "Id": "maxcompute-column:::project_name:[schema_name]:table_name:column_name",
        "Name": "column_name",
        "PartitionKey": false,
        "Position": 1,
        "PrimaryKey": false,
        "StatisticsInfos": {
          "key": ""
        },
        "TableId": "maxcompute-table:::project_name:[schema_name]:table_name",
        "TechnicalMetadata": {
          "Parameters": {
            "key": "keyword"
          }
        },
        "Type": "bigint"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  },
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": 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.