ListProcessDefinitions-阿里云帮助中心

Queries process definitions of a specified type.

Operation description

Description

Queries process definitions of a specified policy type.
This operation supports paginated queries. You can use thePageSize andPageNumber parameters to control the page size and page number.
You can also use theNextToken andMaxResults parameters to page through large result sets.
The response includes the total count, page size, current page number, and a list of process definitions.
Each process definition includes key attributes, such as its ID, enabled status, and 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 (You cannot create custom definitions for this type.) DataAssetGovernance (You cannot create custom definitions for this type.) Lindorm (You cannot create custom definitions for this type.) DlfNext (You cannot create custom definitions for this type.) DlfV1 (You cannot create custom definitions for this type.) StarRocks (You cannot create custom definitions for this type.)

Response elements

Element	Type	Description	Example
	object	Request ID Error message: Populated if the call fails. Error code: Populated if the call fails. A list of process definitions: For more information, see the ProcessDefinition object.
RequestId	string	The request ID.
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries.
ProcessDefinitions	array<object>	A list of process definitions. For more information, see the `ProcessDefinition` object.
	object	A summary of a process definition.
Id	string	The ID of the process definition.
Name	string	The name of the process definition.
Description	string	The description of the process definition.
Type	string	The type of the process definition. Valid values: MaxCompute DataService Extension Hologres DlfV1 (You cannot create custom definitions for this type.) EMR (You cannot create custom definitions for this type.) DataAssetGovernance (You cannot create custom definitions for this type.) Lindorm (You cannot create custom definitions for this type.) StarRocks (You cannot create custom definitions for this type.) DlfNext (You cannot create custom definitions for this type.) DataWorks (You cannot create custom definitions for this type.)
SubType	string	The subtype. Valid values: Table Column Database Schema Default
IsSystem	boolean	Indicates whether this is a default system policy. System policies have restricted update capabilities.
Enabled	boolean	Indicates whether the process definition is enabled.
Priority	string	The priority. A smaller value indicates a higher priority.
Scopes	array	The phases in which the rule is effective. Valid values: `Deployment`: The policy is checked when an application is submitted. `Running`: The policy is checked during process execution to determine if approval can be skipped. (Supported only for the MaxCompute type)
	string	A phase in which the rule is effective.

Examples

Success response

JSON format

{
  "RequestId": "",
  "PagingInfo": {
    "TotalCount": 0,
    "ProcessDefinitions": [
      {
        "Id": "",
        "Name": "",
        "Description": "",
        "Type": "",
        "SubType": "",
        "IsSystem": true,
        "Enabled": true,
        "Priority": "",
        "Scopes": [
          ""
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.