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

Obtiene la política de aprobación para un ID de definición de proceso determinado.

Descripción de la operación

Solicitud

Esta API obtiene los detalles de una definición de proceso de aprobación específica mediante el parámetro ID.
El parámetro ID es obligatorio y debe ser un ID de definición de proceso válido.
La respuesta incluye las propiedades básicas de la definición del proceso de aprobación, las condiciones de regla, las configuraciones del servicio de notificación y los nodos de aprobación.
Una solicitud exitosa devuelve el objeto completo de la definición del proceso. Una solicitud fallida devuelve un código de error y un mensaje para la solución de problemas.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	string	Sí	El ID de la definición del proceso.	f0d6d578-a305-40ac-ba1e-0a09f64cbc69

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud de API.	0bc5df3a17***903790e8e8a
ProcessDefinition	object	La definición del proceso.
Id	string	El ID de la definición del proceso.	210001039767
Name	string	El nombre de la definición del proceso.	MaxCompute 表审批
Description	string	La descripción del proceso de negocio.	订单业务数据审批流程
Type	string	El tipo de definición del proceso. Valores válidos: MaxCompute DataService Extension Hologres DlfV1 (no se admite la creación personalizada). EMR (no se admite la creación personalizada). DataAssetGovernance (no se admite la creación personalizada). Lindorm (no se admite la creación personalizada). StarRocks (no se admite la creación personalizada). DlfNext (no se admite la creación personalizada). DataWorks (no se admite la creación personalizada).	MaxCompute
SubType	string	El subtipo: Table Column Database Schema Default	Table
IsSystem	boolean	Indica si es una política predeterminada del sistema.	false
Enabled	boolean	Indica si está habilitado.	true
RuleConditions	array<object>	La lista de condiciones de regla.
	object	La condición de la regla.
Type	string	El tipo de condición. Es una enumeración: `odpsProject`, `hologresInstanceId` `sensibleLevel`, `tableGuid`, `projectId`	odpsProject
Expression	string	Una expresión condicional tiene el formato `((#type=='typeValue'))`, como `((#odpsProject=='PX_BEIJING_TEST'))`.	((#odpsProject=='PX_BEIJING_TEST'))
Scope	string	La etapa de vigencia de la regla: `Deployment` determina si una solicitud coincide con esta política de aprobación al momento de su envío. `Running` se utiliza para determinar si un proceso de aprobación está exento de aprobación. Esta función solo es compatible con el tipo MaxCompute.	Deployment
NotificationServices	array<object>	La declaración del servicio de notificación.
	object	El servicio de notificación.
Channel	string	El canal de notificación. Es una enumeración: Mail Sms DingRobot Weixin	DingRobot
Extension	string	Información adicional en formato JSON, como `{"atAll":"true"}` para especificar si se debe mencionar a todos los miembros (@all).	{"atAll":"true"}
Receiver	string	Debe especificar WebhookUrl cuando Channel es DingRobot o Weixin.	https://dingtalk.com
ApprovalNodes	array<object>	La lista de nodos de aprobación.
	array<object>	El nodo de aprobación.
Id	string	El ID del nodo.	7a809b6a-2a62-4c6c-9c23-c2a145e3877d
Name	string	Nombre del nodo	default-name
AccountType	string	Tipo de aprobador del nodo: DataWorksProjectRole rol de proyecto DataWorksProjectMember miembro del proyecto TableAdministrator administrador de tabla TableOrProjectAdministrator administrador de tabla o de proyecto AliyunResourceOwner cuenta de Alibaba Cloud MaxComputeRole administrador de MC DLFAdmin y administrador de DlfLegacy Administrador de DLFNext TenantRole rol de inquilino EmrAdministrator administrador de Emr LindormAdministrator administrador de Lindorm AliyunRamUser usuario de RAM	TableOrProjectAdministrator
Assignees	array	`AccountType` tiene diferentes semánticas según el tipo: DataWorksProjectMember especifica el UserId del miembro del proyecto. DataWorksProjectRole especifica el código del rol del proyecto. MaxComputeRole especifica el rol de MaxCompute. TenantRole especifica el código del rol de inquilino. AliyunRamUser especifica el ID del usuario de RAM.
	string	El aprobador.	213463068144525171
ExtensionProperties	object	Cuando `AccountType` se establece en diferentes tipos, debe proporcionar distintas declaraciones adicionales: DataWorksProjectMember: la clave es projectId y el valor son los UserIds de los miembros del proyecto, separados por comas. MaxComputeRole: la clave es un proyecto de MaxCompute y el valor es un nombre de rol en MaxCompute. Varios nombres de rol se separan con coma.
	any	Información adicional.	{ "449656": "role_project_admin,role_project_pe" }

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0bc5df3a17***903790e8e8a",
  "ProcessDefinition": {
    "Id": "210001039767",
    "Name": "MaxCompute 表审批",
    "Description": "订单业务数据审批流程",
    "Type": "MaxCompute",
    "SubType": "Table",
    "IsSystem": false,
    "Enabled": true,
    "RuleConditions": [
      {
        "Type": "odpsProject",
        "Expression": "((#odpsProject=='PX_BEIJING_TEST'))",
        "Scope": "Deployment"
      }
    ],
    "NotificationServices": [
      {
        "Channel": "DingRobot",
        "Extension": "{\"atAll\":\"true\"}",
        "Receiver": "https://dingtalk.com"
      }
    ],
    "ApprovalNodes": [
      {
        "Id": "7a809b6a-2a62-4c6c-9c23-c2a145e3877d",
        "Name": "default-name",
        "AccountType": "TableOrProjectAdministrator",
        "Assignees": [
          "213463068144525171"
        ],
        "ExtensionProperties": {
          "key": "{\n        \"449656\": \"role_project_admin,role_project_pe\"\n      }"
        }
      }
    ]
  }
}

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.