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

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
EntityType	string	Sí	El tipo de entidad. El valor debe coincidir con la expresión regular `^custom_(?:entity-[A-Za-z0-9_]+\|[A-Za-z0-9_]+-(?:database\|table\|column))$`.	custom_entity-customer_api

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud.	C636A747-7E4E-594D-94CD-2B4F8A9A9A63
Success	boolean	Indica si la solicitud se realizó correctamente.	true
MetaEntityDef	MetaEntityDef	La definición de entidad personalizada.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "C636A747-7E4E-594D-94CD-2B4F8A9A9A63",
  "Success": true,
  "MetaEntityDef": {
    "Name": "biz_api",
    "EntityType": "custom_entity-biz_api",
    "DisplayName": "业务API",
    "Description": "test",
    "AttributeDefs": [
      {
        "Name": "apiCode",
        "DisplayName": "API编码",
        "Type": "STRING",
        "IsOptional": true,
        "SearchFilterEnabled": false,
        "DisplayEnabled": true,
        "AllowedValues": [
          "LABEL_1"
        ],
        "Description": "层级描述"
      }
    ],
    "Extend": "NONE",
    "CreateTime": 1780553640613,
    "ModifyTime": 1780553640613
  }
}

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.