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

Crea una definición de 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:CreateCustomAttribute

create

*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. El valor debe coincidir con `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. La parte después de custom-attribute: debe tener menos de 100 caracteres de longitud.	custom-attribute:biz_owner
DisplayName	string	Sí	El nombre para mostrar del atributo personalizado. El valor debe tener menos de 128 caracteres de longitud.	BusinessOwner
Type	string	Sí	El tipo del atributo personalizado. Valores válidos: ENUM, TEXT y HYPERLINK. Valores válidos: ENUM : Tipo de enumeración. HYPERLINK : Tipo de hipervínculo. TEXT : Tipo de texto.	TEXT
EntityTypes	array	Sí	La lista de tipos de entidad aplicables. Se admiten tipos de entidad exactos y patrones con comodines como `-table` y `-column`. Ejemplos: dataworks-project: espacio de trabajo dataworks-dataset: conjunto de datos de DataWorks maxcompute-table: tabla de MaxCompute *-column: todos los tipos de columna
	string	No	El tipo de entidad.	maxcompute-table
ValueEnums	array	No	Los valores de enumeración. Este parámetro es obligatorio cuando el tipo se establece en ENUM. Este parámetro no es compatible con los tipos TEXT o HYPERLINK.
	string	No	El valor de enumeración.	VALUE_1
DisplayEnabled	boolean	No	Especifica si se debe mostrar el atributo en la página de detalles. Valor predeterminado: true.	true
SearchFilterEnabled	boolean	No	Especifica si el atributo puede usarse como condición de filtro en la página de búsqueda de Data Map de DataWorks. Valor predeterminado: false. Actualmente, solo el tipo ENUM admite establecer este valor en true.	false
Comment	string	No	La descripción del atributo personalizado. El valor debe tener menos de 256 caracteres de longitud.	test comment

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71
Success	boolean	Indica si la solicitud se realizó correctamente.	true
Result	boolean	El resultado de la creación.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71",
  "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.