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

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID. Você pode obter este valor a partir da resposta da operação ListColumns. Para mais informações, consulte Conceitos de entidade de metadados. O formato é `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}:${TableName}:${ColumnName}`. Use uma string vazia como placeholder para níveis que não existem. Nota Para tipos MaxCompute e DLF, use uma string vazia como placeholder para o ID da instância. Para MaxCompute, o nome do banco de dados é o nome do projeto MaxCompute. Projetos com o modelo de três camadas habilitado devem incluir o nome do schema. Para projetos sem o modelo de três camadas, use uma string vazia como placeholder para o nome do schema. Nota Para StarRocks, o identificador do catálogo de dados é o nome do catálogo. Para DLF, o identificador do catálogo de dados é o ID do catálogo. Outros tipos não suportam o nível de catálogo. Use uma string vazia como placeholder. A seguir estão exemplos de formato de ID para tipos comuns: `maxcompute-column:::project_name:[schema_name]:table_name:column_name` `dlf-column::catalog_id:database_name::table_name:column_name` `hms-column:instance_id::database_name::table_name:column_name` `holo-column:instance_id::database_name:schema_name:table_name:column_name` `mysql-column:(instance_id\|encoded_jdbc_url)::database_name::table_name:column_name` Nota Outros parâmetros: `instance_id`: O ID da instância. Este parâmetro é obrigatório quando a fonte de dados é registrada no modo de instância. `encoded_jdbc_url`: A string de conexão JDBC codificada em URL. Este parâmetro é obrigatório quando a fonte de dados é registrada usando uma string de conexão. `catalog_id`: O ID do catálogo DLF. `project_name`: O nome do projeto MaxCompute. `database_name`: O nome do banco de dados. `schema_name`: O nome do schema. Para MaxCompute, este parâmetro é obrigatório apenas quando o modelo de três camadas está habilitado para o projeto. Se o modelo de três camadas não estiver habilitado, use uma string vazia como placeholder. `table_name`: O nome da tabela. `column_name`: O nome da coluna.	maxcompute-column:::project_name:[schema_name]:table_name:column_name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Column	Column	A lista de colunas.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "Column": {
    "Id": "maxcompute-column:::project_name:[schema_name]:table_name:column_name",
    "Name": "column_name",
    "Comment": "字段1",
    "TableId": "maxcompute-table:::project_name:[schema_name]:table_name",
    "Position": 1,
    "Type": "bigint",
    "PrimaryKey": false,
    "PartitionKey": false,
    "ForeignKey": false,
    "BusinessMetadata": {
      "Description": "字段1的业务描述",
      "CustomAttributes": {
        "key": [
          "张三"
        ]
      }
    },
    "StatisticsInfos": {
      "key": ""
    }
  }
}

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.