ListCustomAttributes - DataWorks - Centro de documentación de Alibaba Cloud

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:ListCustomAttributes

list

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
DisplayName	string	No	El nombre para mostrar del atributo personalizado. El valor se busca mediante coincidencia por contención de texto sin formato.	Owner
EntityTypes	string	No	Los tipos de entidad a los que se aplica el atributo personalizado. Separe múltiples tipos de entidad con comas, como `-table,-column`. Se admiten tipos de entidad específicos (como hms-table y emr-table) y tipos con comodines `-table` y `-column`.	maxcompute-table
Comment	string	No	La descripción del atributo personalizado. El valor se busca mediante coincidencia aproximada.	owner
SortBy	string	No	El campo de ordenación. Valores válidos: CreateTime y ModifyTime. Valores válidos: ModifyTime : Ordenar por hora de modificación. Type : Ordenar por tipo. CreateTime : Ordenar por hora de creación. Name : Ordenar por nombre.	CreateTime
Order	string	No	El orden de clasificación. Valores válidos: Asc y Desc. Valores válidos: Asc : Orden ascendente. Desc : Orden descendente.	Asc

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	54594ACA-7976-5273-958B-02E15E9B867C
Success	boolean	Indica si la solicitud se realizó correctamente.	true
PagingInfo	object	La información de paginación.
TotalCount	integer	El número total de entradas.	10
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página.	10
CustomAttributes	array	La lista de objetos de atributos personalizados.
	CustomAttribute	El objeto de atributo personalizado.

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.