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

Actualiza un atributo personalizado.

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

update

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	string	Sí	El ID del atributo personalizado.	custom-attribute:biz_owner
DisplayName	string	No	El nuevo nombre para mostrar del atributo personalizado. Debe tener menos de 128 caracteres.	Business owner
EntityTypes	array	No	Los tipos de entidad aplicables. Este parámetro admite tipos específicos y formatos de comodín, como `-table` y `-column`. Por ejemplo: `dataworks-project`: un espacio de trabajo de DataWorks `dataworks-dataset`: un conjunto de datos de DataWorks `maxcompute-table`: una tabla de MaxCompute `*-column`: todos los tipos de columna
	string	No	El tipo de entidad.	maxcompute-table
ValueEnums	array	No	Los valores enumerados. Esto se aplica solo a los atributos personalizados de tipo `enum`. Solo puede agregar nuevos valores durante una actualización.
	string	No	Un valor para la enumeración.	VALUE_1
DisplayEnabled	boolean	No	Especifica si se debe mostrar el atributo personalizado en la interfaz de usuario.	true
SearchFilterEnabled	boolean	No	Especifica si el atributo personalizado se puede usar como condición de filtro.	false
Comment	string	No	La nueva descripción del atributo personalizado. Debe tener menos de 256 caracteres.	test comment

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
RequestId	string	El ID de la solicitud.	6B56C4A2-C7F3-52AF-8417-6DFF7447011B
Success	boolean	Indica si la solicitud se realizó correctamente.	true
Result	boolean	Indica si la operación de actualización se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "6B56C4A2-C7F3-52AF-8417-6DFF7447011B",
  "Success": true,
  "Result": true
}

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.