ListProcessDefinitions - ListProcessDefinitions-DataWorks(DataWorks)-阿里云帮助中心

Queries approval process definitions by type.

Operation description

Request description

Queries approval process definitions based on a specified policy type (PolicyType).
Supports paginated queries. Use the PageSize and PageNumber parameters to control the page size and page number.
The NextToken and MaxResults parameters are also available for paging through large result sets.
The response includes the total count (TotalCount), page size (PageSize), page number (PageNumber), and a list of process definitions.
Each process definition includes key attributes, such as its ID, enabled status (Enabled), and priority (Priority).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The type of the process definition. Valid values: MaxCompute DataService Extension Hologres Emr DataAssetGovernance Lindorm DlfNext DlfV1 StarRocks	MaxCompute

Response elements

Element	Type	Description	Example
	object	The request ID. The error message. This parameter is returned only if the request failed. The error code. This parameter is returned only if the request failed. The list of process definitions. For more information, see ProcessDefinition.
RequestId	string	The request ID.	0bc5df3a17***903790e8e8a
PagingInfo	object	The list of process definitions. For more information, see ProcessDefinition.
TotalCount	integer	The total number of entries.	100
ProcessDefinitions	array	The list of process definitions. For more information, see ProcessDefinition.
	object	The summary of the process definition.
Id	string	The process definition ID.	10354346
Name	string	The name of the process definition.	MaxCompute Table Approval
Description	string	The description of the process definition.	The MaxCompute table approval policy for the lwt_ide_simple project.
Type	string	The type of the process definition. Valid values: MaxCompute DataService Extension Hologres DlfV1 (custom creation is not supported) Emr (custom creation is not supported) DataAssetGovernance (custom creation is not supported) Lindorm (custom creation is not supported) StarRocks (custom creation is not supported) DlfNext (custom creation is not supported) DataWorks (custom creation is not supported)	MaxCompute
SubType	string	The subtype. Valid values: Table Column Database Schema Default	Table
IsSystem	boolean	Indicates whether the process definition is a system default. For system policies, only the notification service can be updated.	false
Enabled	boolean	Indicates whether the process definition is enabled.	true
Priority	string	The priority. A smaller value indicates a higher priority.	1
Scopes	array	The stages in which the rule takes effect. Valid values: `Deployment`: determines whether the approval policy matches when an application is submitted. `Running`: determines whether approval is exempt during execution. Supported only for the MaxCompute type.
	string	The stage in which the rule takes effect.	Deployment

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17***903790e8e8a",
  "PagingInfo": {
    "TotalCount": 100,
    "ProcessDefinitions": [
      {
        "Id": "10354346",
        "Name": "MaxCompute Table Approval",
        "Description": "The MaxCompute table approval policy for the lwt_ide_simple project.",
        "Type": "MaxCompute",
        "SubType": "Table",
        "IsSystem": false,
        "Enabled": true,
        "Priority": "1",
        "Scopes": [
          "Deployment"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.