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

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

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
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
DisplayName	string	Não	O nome de exibição do atributo personalizado. O valor é correspondido por contenção de texto simples.	Owner
EntityTypes	string	Não	Os tipos de entidade aos quais o atributo personalizado se aplica. Separe vários tipos de entidade com vírgulas, como `-table,-column`. Tipos de entidade específicos (como hms-table e emr-table) e tipos curinga `-table` e `-column` são suportados.	maxcompute-table
Comment	string	Não	A descrição do atributo personalizado. O valor é correspondido de forma aproximada.	owner
SortBy	string	Não	O campo de ordenação. Valores válidos: CreateTime e ModifyTime. Valores válidos: ModifyTime : Ordenar por hora de modificação. CreateTime : Ordenar por hora de criação. Type : Ordenar por tipo. Name : Ordenar por nome.	CreateTime
Order	string	Não	A ordem de classificação. Valores válidos: Asc e Desc. Valores válidos: Asc : Ordem crescente. Desc : Ordem decrescente.	Asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	54594ACA-7976-5273-958B-02E15E9B867C
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas.	10
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
CustomAttributes	array	A lista de objetos de atributo personalizado.
	CustomAttribute	O objeto de atributo personalizado.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "54594ACA-7976-5273-958B-02E15E9B867C",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "CustomAttributes": [
      {
        "Id": "custom-attribute:biz_owner",
        "DisplayName": "业务负责人",
        "Type": "TEXT",
        "EntityTypes": [
          "maxcompute-table"
        ],
        "ValueEnums": [
          "VALUE_1"
        ],
        "SearchFilterEnabled": false,
        "DisplayEnabled": true,
        "Comment": "this is a comment",
        "CreateTime": 1750817692000,
        "ModifyTime": 1763380628000
      }
    ]
  }
}

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.