tencent cloud

APIs

文档APIsTencent Cloud DataBuddyData Types

Data Types

下载
聚焦模式
字号
最后更新时间： 2026-10-11 15:49:07

AddConsoleUsersRsp

for adding a console user

Used by actions: AddConsoleUsers.

Name Type Description
Status Boolean Whether the operation is successful

AdvancedDependencyConfig

Advanced dependency configuration

Used by actions: CreateWorkflow, ListWorkflowTaskRuns, ListWorkflows.

Name Type Required Description
Operator String No Logical operation symbols OR / AND
Conditions Array of TaskRunConditionRule No List of conditional rules for task running

AdvancedParameter

Advanced running parameters (parameters filled in by the user during advanced workflow running)

Used by actions: GetWorkflowRun, ListWorkflowRuns.

Name Type Required Description
ParamKey String No Parameter name.
ParamValue String No Parameter value.

AlarmBrief

Alarm configuration

Used by actions: CreateWorkflow, GetWorkflow, UpdateWorkflow.

Name Type Required Description
AlarmId String No Alarm ID. No need to import upon creation, as it is generated by the server.
AlarmMonitorType String No Monitored object type of the alarm, such as workflow or task. Currently supported: 1. WORKFLOW 2. TASK
AlarmGroups Array of AlarmGroup No Alarm groups. A maximum of 50 alarm groups is allowed.
DoNotDisturbWhenSkipped Boolean No Notification muting when skipped. Default value: false.
DoNotDisturbWhenManuallyTerminated Boolean No Notification muting upon manual termination. The default value is false.
DoNotDisturbUntilTheLastRetry Boolean No Notification muting before the last retry. Default value: false.

AlarmGroup

Alarm group

Used by actions: CreateWorkflow.

Name Type Required Description
ChannelId String No

Notification channel ID, which can be obtained through the notification channel APIs of the basic platform
ChannelName String No

Notification channel name, which can be a user group name or email address
IsEmailChannel Boolean No

Whether to enable the email channel. Default value: false
AlarmConditions Array of String No

Alarm condition list. Value:
START: Start up
SUCCESS: Success
FAILURE: Failure
MONITOR_INDICATOR_ALARM: Monitoring metric alarm
ChannelType Integer No

Notification channel type. Value: 0 unspecified, 1 Email, 2 Webhook, 3 Teams, 4 Slack

AsyncActionRsp

Item-by-item result of a batch asynchronous operation

Used by actions: KillWorkflowRun, RerunWorkflowRun, RunWorkflow.

Name Type Required Description
ActionResults Array of RunActionBrief No Result list of multiple action items

AsyncOperation

Information about asynchronous file operations in the OneFlow passthrough Workspace. Job status is persisted and maintained by Workspace.

Used by actions: CreateFile, GetFile, UpdateFile.

Name Type Required Description
IsAsync Boolean Yes Whether to execute asynchronously; true for ZIP decompression upon creation
JobId String Yes Workspace-persistent async job ID, used for querying job progress.
OperationId String Yes Idempotency and link tracing flag generated by the caller for the submission
Status Integer Yes Async job status: 0 - not specified, 1 - accepted, 2 - decompressing, 3 - callback processing, 4 - successful, 5 - partially failed, 6 - failed

Audit

Audit information

Used by actions: CreateSchema, GetCatalog, ListCatalogs, ListSchemas.

Name Type Required Description
Creator String No Creator. Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String No Creation Timestamp
LastModifier String No Last modifier. Note: This field may return null, indicating that no valid value can be obtained.
LastModifiedAt String No Last modification timestamp
CreatorName String No Creator name.
LastModifierName String No Name of the last modifier

Catalog

Data catalog entity structure

Used by actions: GetCatalog, ListCatalogs.

Name Type Required Description
Id String No

Unique id of the data catalog.
Name String No

Data catalog name.
Type String No

Data catalog type
Comment String No

Data catalog description
Status String No

Status info: being registered 0, trial 1, connected successfully 2, connection failure 3, deleting 4, deleted 5
Properties Array of KVPair No

Data catalog properties
Operator String No

Operator
MetaOwner MetaOwner No

Responsible person information.
Audit Audit No

Audit information
AssetGuid String No

Globally unique ID of the asset
CurrentWorkspacePermissionLevel Integer No

Current workspace permission level. The value corresponds to PermissionLevel: 0 - no permission, 1 - read-only, 2 - read-write
Identifier String No

tccatalog.identifier in tccatalog properties
PermissionDetail PermissionDetail No

Permission information of the current user for this entity.
IsExternal Boolean No

Whether it is an external data Catalog (a Catalog created based on a data source connection, such as MYSQL, EMR_HIVE, TCHOUSE_D, POSTGRESQL, DLC). true: external Catalog, false: built-in Catalog (TABLE/MODEL/VOLUME)
Tags Array of CommonTagInfo No

Tag information list. Note: It is returned only when FetchTags=true in the request. By default, it is not returned.
CatalogSource String No

Data catalog source
ConnectionCatalogName String No

The data catalog name or database name on the connection side (only available for three-segment data sources in the analytics edition; empty string for two-segment data sources). For MySQL-kernel three-segment data sources such as Doris/StarRocks/TChouse-D: external catalog name; for PG-kernel three-segment data sources such as PostgreSQL/Tencent PG/GaussDB/Hologres: databaseName; for two-segment data sources such as MySQL: empty string. Note: This field is only valid for the analytics edition (CatalogSource=CONNECTION) and is not filled for the pro edition (METALAKE).

CommonFailItem

Common error information

Used by actions: RemoveConsoleUsers.

Name Type Description
Item String

uin or groupId
FailReason String

Error information.

CommonTagInfo

Common tag information (for query display scenarios), suitable for lightweight display of various asset tags such as table tags and field tags, for use in API responses such as GetTable.

Used by actions: CreateSchema, GetCatalog, ListCatalogs, ListSchemas.

Name Type Required Description
LabelId String No Tag ID
LabelName String No Tag name.
LabelValueId String No Tag value ID. For property tags (LabelType=3), it can be 0.
LabelValue String No Tag value. It can be empty for a masking tag (LabelType=4).
Type Integer No Tag type. For valid values, see the LabelType enum definition: 1 - governance tag, 2 - custom tag, 3 - property tag, 4 - masking tag.
Deleted Boolean No Whether the tag has been deleted. true indicates that no record of this LabelId is found in meta_biz_label and the tag has been physically deleted; false (default) indicates that the tag still exists.

ConsoleGroupInfo

Console user group information (external standard version, decoupled from internal UserGroupRoleInfo)

Used by actions: ListConsoleGroups.

Name Type Description
GroupId String User group ID.
GroupName String User group name.
Roles Array of RoleBasicInfo List of characters.
CreateTime String Creation time.
UpdateTime String Update time.
UserCount Integer Number of users in the user group
GroupType String User group type. The value is a string form of an enumerated numeric value: "0" = console system type (including all users), "1" = console custom type, "2" = workspace system type, "3" = workspace custom type.

ConsoleGroupUserInfo

Console user group member info (external standard version, decoupled from internal GroupUserInfo)

Used by actions: ListConsoleGroupUsers.

Name Type Description
UserUin String User UIN
UserName String Username.
Nickname String Nickname
CreateTime String Creation time.
UpdateTime String Update time.

ConsoleRoleInfo

Console role information (external standard version, decoupled from internal Role)

Used by actions: ListConsoleRoles.

Name Type Description
BasicInfo RoleBasicInfo Basic information about the role
MetaData RoleMetaData Role meta-information.
Permissions Array of RolePermission Role permission

ConsoleUserInfo

Console user information (normalized, decoupled from internal UserDetailInfo)

Used by actions: ListConsoleUsers.

Name Type Description
UserUin String User UIN.
UserName String Username.
Nickname String Nickname
Roles Array of RoleBasicInfo List of characters.
UserSource String User source. group: user group, user: user
CreateTime String Creation time.
UpdateTime String Update time.
IsOwner Boolean Whether it is the root account.
UserTag Integer 0: general user; 1: Entra ID user.
IsAdmin Boolean Whether it is a sub-account with admin permission

CreateCatalogRsp

Response to the data catalog creation

Used by actions: CreateCatalog.

Name Type Description
CatalogId String id of the data directory created

CreateConsoleGroupRsp

for creating a console user group

Used by actions: CreateConsoleGroup.

Name Type Description
GroupId String ID of the successfully created user group

CreateFolderRsp

Response for folder creation

Used by actions: CreateFolder.

Name Type Required Description
FolderId String No

Folder ID

CreateSchemaRsp

to schema creation

Used by actions: CreateSchema.

Name Type Description
Schema Schema schema information

CreateWorkflowRsp

CreateWorkflowRsp

Used by actions: CreateWorkflow.

Name Type Required Description
WorkflowId String No Workflow ID

CreateWorkspaceRoleResult

Workspace role creation result

Used by actions: CreateWorkspaceRole.

Name Type Description
RoleId String Role id.
Status Boolean Whether the workspace role is created successfully

CreateWorkspaceRsp

of workspace creation

Used by actions: CreateWorkspace.

Name Type Required Description
WorkspaceId String No Workspace ID after successful creation

DeleteCatalogRsp

Response to the data catalog description deletion

Used by actions: DeleteCatalog.

Name Type Description
Result Boolean Operation result

DeleteConsoleGroupsRsp

to deletion of a console user group

Used by actions: DeleteConsoleGroups.

Name Type Description
Status Boolean Whether the operation is successful

DeleteFileResult

File deletion result

Used by actions: DeleteFile.

Name Type Required Description
FileId String No

Deleted file ID.
Status Boolean No

Whether deletion is successful

DeleteFolderRsp

Response for folder deletion

Used by actions: DeleteFolder.

Name Type Required Description
Status Boolean No

Delete folder status

DeleteSchemaRsp

for deleting a Schema

Used by actions: DeleteSchema.

Name Type Description
Result Boolean Operation result

DeleteWorkflowRsp

DeleteWorkflowRsp

Used by actions: DeleteWorkflow.

Name Type Required Description
Status Boolean No Deletion status. true indicates success.

DeleteWorkspaceRoleResult

Result of deleting the workspace role

Used by actions: DeleteWorkspaceRole.

Name Type Description
Status Boolean Whether the workspace role is deleted successfully

DeleteWorkspaceRsp

to workspace deletion

Used by actions: DeleteWorkspace.

Name Type Required Description
Status Boolean No Whether the operation is successful

DependOnBrief

Brief information of task dependency

Used by actions: CreateWorkflow, ListWorkflows.

Name Type Required Description
TaskId String No Task ID, which can be obtained through the ListWorkflowTasks API.
TaskName String No Task name.

FetchOption

Data access options for controlling which additional content to return in the response to get/list requests.

Used by actions: GetCatalog, ListCatalogs, ListSchemas.

Name Type Required Description
FetchPermissions Boolean No

Whether to return the permission list in response. Default false.
FetchFeatureTableDetail Boolean No

Whether to obtain feature table details. Valid when AssetType is TABLE.
FilterPermissions Array of String No

Filter by permission. Pass in a list of permissions to return only entities for which the current user has the specified permissions. For example, passing in ["SELECT_TABLE"] returns only entities for which the current user has the SELECT_TABLE permission. This only takes effect for the list Interface. If empty, no permission filtering is performed.
FetchOwners Boolean No

Whether to return person in charge information in response. If this parameter is not passed or is true, the person in charge information is returned by default. If it is explicitly set to false, it is not returned.
FetchUserInfo Boolean No

Whether to convert user Uin to userName. Impact range: CreatorName/LastModifierName in Audit, OwnerName in MetaOwner. If not passed or set to true, conversion is executed (default conversion). If explicitly set to false, do not convert
FetchMask Boolean No

Whether to return field masking policy information. It is not returned by default. If true is passed in, the field masking policy information corresponding to the table fields will be queried.
FetchTags Boolean No

Whether to return tag information. By default, it is not returned. When set to true, APIs such as GetTable/ListTables/GetCatalog/ListCatalogs/GetSchema/ListSchemas/GetView/ListViews/GetFunction/ListFunctions/GetVolume/ListVolumes/GetModel/ListModels will return the Tags field in the corresponding entity.
FetchDimensions Boolean No

Whether to return the dictionary dimension information associated with the returned field. Default not passed, do not return

FileConfig

File operation configuration.

Used by actions: CreateFile, GetFile, UpdateFile.

Name Type Required Description
Params String No

Advanced running parameter, used for variable replacement, map-json String,String
ResourceId String No

Execution resource ID. Source: ResourceId returned by the ListComputeResources API
DefaultCatalog String No

Default catalog
DefaultSchema String No

Default schema
AdvanceConfig String No

Advanced configuration, JSON string
ExtraParams String No

Extended parameter, JSON string
Widgets String No

Notebook interactive control definition, JSON string
OutputConf Array of FileOutputConf No

Output configuration of each cell. Returned only in Get output parameters; input parameters are ignored.
SqlSyntax String No

SQL script grammar tag
ClusterId String No

Platform cluster id
DefaultCatalogSource String No

The source type of the default Catalog, used to identify which Catalog system the default Catalog belongs to. Selectable. Maximum length: 32. Values: METALAKE - TC Catalog (metadata lake Catalog); SETATS - Setats Catalog. If the value is empty or illegal, the backend falls back to METALAKE.

FileInfo

File detail

Used by actions: CreateFile, GetFile, UpdateFile.

Name Type Required Description
AppId String No

Root account AppId
WorkspaceId String No

Workspace ID
FileId String No

File ID
FileName String No

File name, including suffix
FileType String No

File type. Parameter Value: FILE (regular file/script), NOTEBOOK_FILE (Notebook), SQL_FILE (SQL file). Corresponds to common/domain/entity.proto EntityType
Path String No

Full path of the file in the workspace, starting with /, for example /etl/daily/demo.ipynb
FileConfig FileConfig No

File operation configuration.
BundleId String No

Bound BundleId
BundleInfo String No

Bound BundleInfo, JSON string
Status String No

File status. active=normal, deleted=deleted
OwnerUserName String No

File owner userName
CreateUserUin String No

Creator sub-account Uin.
UpdateUserUin String No

Last updated by sub-account Uin
CreateTime String No

Creation time, millisecond-level timestamp
UpdateTime String No

Latest update time, millisecond-level timestamp
Storage FileStorage No

File storage information. Content is returned only when the request IncludeContent=true
Permissions String No

Permission point list of the current caller for the file
ReleaseStatus Boolean No

Whether it is released
ResourceMode Integer No

Resource mode. 1=distributed, 2=single-node
AsyncOperation AsyncOperation No

Pass through Workspace job information during async file preview job creation; leave this field unset for ordinary sync creation or other APIs that reuse this return structure
VersionId String No

Script version ID.

FileMeta

File Metadata

Used by actions: GetFolder, ListFiles.

Name Type Required Description
FileId String No

File id
FileName String No

File/folder name
FileType String No

File type
CreateTime String No

Creation time. Millisecond unix second-level timestamp

Parameter format: timestamp
UpdateTime String No

Update time

Parameter format: timestamp string
AllowActions Array of String No

acl permission type
IsFavorite Boolean No

Whether to collect
PathName String No

File path
IsSystemGenerated Boolean No

Whether it is generated by the system

FileNode

File node

Used by actions: GetFolder, ListFiles.

Name Type Required Description
Node FileMeta No

Current node
Parent FileMeta No

Parent node
Creator UserInfo No

Creator
Owner UserInfo No

Owner
NodeType String No

Node type.
OriginPath String No

Original path
DeleteTime String No

Recycle time
GitConfig GitRepoConfig No

File git configuration.

FileOutputConf

Notebook/Python cell output configuration

Used by actions: CreateFile, GetFile, UpdateFile.

Name Type Required Description
CellId String No Cell ID
DashboardConf String No Dashboard chart configuration, JSON string
OutputPath String No Pre-signed download URL of the execution result file

FileStorage

File storage

Used by actions: CreateFile, GetFile, UpdateFile.

Name Type Required Description
StorageType Integer No Storage type
StoragePath String No Storage path
Content String No File content

FolderLocator

Folder locator

Used by actions: CreateFolder, DeleteFolder, GetFolder, ListFiles, UpdateFolder.

Name Type Required Description
FolderId String No

Node ID.
PathName String No

Node path

GetCatalogRsp

Response to the data catalog detail query

Used by actions: GetCatalog.

Name Type Description
Catalog Catalog catalog description

GetFolderRsp

Response of getting a folder

Used by actions: GetFolder.

Name Type Required Description
Folder FileNode No

Folder information

GetWorkflowRsp

GetWorkflowRsp

Used by actions: GetWorkflow.

Name Type Required Description
WorkspaceId String No

Workspace ID
BaseInfo WorkflowBaseInfoDetail No

Workflow basic info
Trigger Array of WorkflowTriggerConfiguration No

Workflow scheduling configuration.
ParamList Array of ParamInfo No

Workflow parameter list. The parameter name is required and can only contain digits, upper- and lower-case letters, spaces, .$@#!%^&*()-_+=>
LabelList Array of LabelBrief No

Tag name is required and can only contain digits, upper- and lower-case letters, spaces, .$@#!%^&*()-_+=>
Alarm AlarmBrief No

Workflow alert configuration.
MonitorMetric MonitorMetricBrief No

Monitoring metrics configuration
AdvanceConfig WorkflowAdvanceConfig No

Workflow advanced setting.
TaskList Array of WorkflowTask No

Workflow task list
BundleId String No

Unique ID of the Bundle bound to the workflow. It is empty if not bound.
BundleInfo String No

Bundle information.
GitConfigId String No

Git configuration ID.
GitBranch String No

Git branch information.

GetWorkflowRunRsp

to the workflow running details query.

Used by actions: GetWorkflowRun.

Name Type Required Description
WorkflowRun WorkflowRun No Workflow running information

GetWorkflowTaskRunRsp

GetWorkflowTaskRunRsp

Used by actions: GetWorkflowTaskRun.

Name Type Required Description
TaskName String No

Task name.
WorkflowTaskRunId String No

Task running ID.
RunState String No

Running state. For parameter values, see the workflow task running status enumeration, such as Pending / Running / Succeeded / Failed / Killed
WorkspaceId String No

Workspace ID
WorkflowId String No

Workflow ID
WorkflowRunId String No

Workflow run ID
TaskId String No

Task ID.
TaskTypeName String No

Task Type Name. For details, see the TaskTypeName field description in the TaskType data structure.
TaskVersionId String No

Task version ID.
TriggerType String No

Trigger type

Enumeration values:

  • Scheduler: Scheduling trigger
  • Manual: Manual triggering
ResourceGroupId String No

Associated resource group ID
ErrorCodeString String No

Error code
RunUserUin String No

Running user UIN.
RunUserName String No

Running user name.
CreateUserUin String No

Creator UIN
JobId String No

Execution platform execution ID.
CreateTime String No

Creation time, unit: timestamp in milliseconds
UpdateTime String No

Update time, unit: timestamp in milliseconds
DependenceFinishedTime String No

Dependency task completion time, unit: timestamp in milliseconds
RunStartTime String No

Start time, unit: timestamp in milliseconds
RunEndTime String No

Running end time, unit: millisecond timestamp
RunCostTime String No

Running time, unit: seconds
WaitTime String No

Waiting duration (waiting duration from dependency readiness to start), unit: seconds
IssueTime String No

Execution platform time, unit: timestamp in milliseconds
TimeZone String No

Time zone
DependOnList Array of String No

Depend on upstream Task ID list. Reserved field, temporarily returns []

Reserved field, temporarily returns []
RunParams String No

Running parameter
TaskTypeExtensions String No

Task extension information, including script path
LeftCoordinate Float No

X coordinate of the task
TopCoordinate Float No

Task Y-axis coordinate
RetryTimes Integer No

Number of retries.
WorkflowName String No

Workflow name
RerunTimes Integer No

Rerun count
IsLatestRun Boolean No

Whether it is the most recent run
ResourceGroupInfoList Array of ResourceGroupInfo No

Resource group information list.
ErrorMessage String No

Error message.
RunResult String No

Execution result
InnerWorkflowTaskRun InnerWorkflowTaskRun No

Built-in workflow task execution details (only for FOR_EACH tasks; this field is not returned for other task types)
ScheduledTime String No

Scheduled dispatch time

Parameter format: timestamp in milliseconds (UTC)

GetWorkspaceRsp

of querying workspace details

Used by actions: GetWorkspace.

Name Type Required Description
WorkspaceInfo WorkspaceInfo No Workspace details

GitRepoConfig

git configuration.

Used by actions: CreateFolder, GetFolder, ListFiles.

Name Type Required Description
SparseCheckout SparseCheckoutConfig No

Checkout rules
RepoUrl String No

Git repository URL
Branch String No

Branch name.
AuthConfigName String No

Associated gitAuth configuration name

InnerWorkflowTaskBrief

Built-in workflow task brief information (currently only FOR_EACH workflow tasks have a value for this field)

Used by actions: ListWorkflowTaskRuns.

Name Type Required Description
TaskId String No Task ID.
TaskName String No Task name.
TaskTypeName String No Task Type Name. For details, see the description of the TaskTypeName field in the TaskType data structure.

InnerWorkflowTaskRun

Built-in workflow task execution details (FOR_EACH tasks only)

Used by actions: GetWorkflowTaskRun.

Name Type Required Description
PageNumber Integer No Current page
PageSize Integer No Page Size
TotalCount Integer No Total number of records
TotalPageNumber Integer No Total pages
Items Array of InnerWorkflowTaskRunIteration No Iteration run list
IterationCount Integer No Number of iterations.
FailureCount Integer No Number of failures
SuccessCount Integer No Number of successes
InnerWorkflowId String No Built-in workflow ID, which can be obtained through ListWorkflows
InnerTaskId String No Built-in task ID, which can be obtained through ListWorkflowTasks.
InnerTaskRunBizEnumInfos Array of ScheduleBizEnumBrief No Statistics on the number of built-in task running statuses (list of key-value pairs for instance business enums)

InnerWorkflowTaskRunIteration

Running information of a single iteration of the built-in workflow

Used by actions: GetWorkflowTaskRun.

Name Type Required Description
WorkflowRunId String No

Built-in flow running ID
IterationIndex String No

Iteration serial number
RunStartTime String No

Start time in milliseconds.
RunEndTime String No

Running end time, unit: timestamp in milliseconds
RunState String No

Running state (for reference, see the workflow execution status enumeration)
RunCostTime String No

Running time, unit: seconds
WorkflowParams String No

Running parameter
ErrorCodeString String No

Error code
InnerTaskRun InnerWorkflowTaskRunIterationBrief No

Task operation inside the built-in workflow

InnerWorkflowTaskRunIterationBrief

Brief running information of tasks in an iteration of the built-in workflow

Used by actions: GetWorkflowTaskRun.

Name Type Required Description
WorkflowTaskRunId String No

Task running ID
IterationIndex String No

Iteration serial number
RunStartTime String No

Start time in milliseconds.
RunEndTime String No

Running end time, unit: timestamp in milliseconds
RunState String No

Running state
RunCostTime String No

Running time, unit: seconds
TaskParams String No

Running parameter
ErrorCodeString String No

Error code

InnerWorkflowTaskRunListOption

Built-in workflow task run list option (only for FOR_EACH tasks)

Used by actions: GetWorkflowTaskRun.

Name Type Required Description
PageNumber Integer No

Page number. Value range: starts from 1. Optional. Default value: 1.
PageSize Integer No

Size per page. Optional. Default: 10. Value range: [10, 200]
RunStates Array of String No

Iterative running state, exact matching. Optional, multiple selection (multiple values are in an OR relationship).

You can enter SUCCESS / FAILED, for example. For details, refer to the return value of the InnerWorkflowTaskRunIteration.RunState field in the API output parameter.

KVPair

Extended information key-value pair

Used by actions: CreateSchema, GetCatalog, ListCatalogs, ListSchemas.

Name Type Required Description
Key String No Key.
Value String No Value.

LabelBrief

Tag information

Used by actions: CreateWorkflow, GetWorkflow, GetWorkflowRun, ListWorkflowRuns, ListWorkflows, UpdateWorkflow.

Name Type Required Description
LabelKey String No Tag name.
LabelValue String No Tag value.
LabelKeyId String No Tag name ID, obtainable through tag-related APIs
LabelValueId String No Tag value ID, which can be obtained through tag relevant APIs.

ListCatalogsRsp

for retrieving the data catalog list

Used by actions: ListCatalogs.

Name Type Description
Items Array of Catalog Data catalog list
NextPageToken String Next page pagination token

ListConsoleGroupUsersRsp

for querying the console user group member list

Used by actions: ListConsoleGroupUsers.

Name Type Description
Items Array of ConsoleGroupUserInfo User group member list
PageNumber Integer Current page
PageSize Integer Page Size
TotalCount Integer Total number of records
TotalPageNumber Integer Total pages

ListConsoleGroupsRsp

List of console user groups

Used by actions: ListConsoleGroups.

Name Type Description
Items Array of ConsoleGroupInfo User group list.
PageNumber Integer Current page
PageSize Integer Page Size
TotalCount Integer Total number of records
TotalPageNumber Integer Total pages

ListConsoleRolesRsp

for querying the console role list

Used by actions: ListConsoleRoles.

Name Type Description
Items Array of ConsoleRoleInfo List of characters.
PageNumber Integer Current page
PageSize Integer Page Size
TotalCount Integer Total number of records
TotalPageNumber Integer Total pages

ListConsoleUsersRsp

List of console users

Used by actions: ListConsoleUsers.

Name Type Description
Items Array of ConsoleUserInfo User list.
PageNumber Integer Current page
PageSize Integer Page Size
TotalCount Integer Total number of records
TotalPageNumber Integer Total pages

ListFilesRsp

Result of querying file information

Used by actions: ListFiles.

Name Type Description
Items Array of FileNode

File/folder node list
PageNumber Integer

Current page
PageSize Integer

Entries per page
TotalCount Integer

Total quantity.
TotalPageNumber Integer

Total number of pages

ListSchemasRsp

to schema list retrieval

Used by actions: ListSchemas.

Name Type Description
Items Array of Schema schema list
NextPageToken String Next page pagination token

ListWorkflowRunsRsp

ListWorkflowRunsRsp

Used by actions: ListWorkflowRuns.

Name Type Required Description
PageNumber Integer No Current page
PageSize Integer No Page Size
TotalCount Integer No Total number of records
TotalPageNumber Integer No Total pages
Items Array of WorkflowRun No Workflow run list
BizStateEnumInfos Array of ScheduleBizEnumBrief No Statistics of workflow execution status.
Statistical caliber is the full data under current filter conditions, unaffected by PageNumber/PageSize.
BizErrorCodeEnumInfos Array of ScheduleBizEnumBrief No Statistics of workflow execution error codes.
Statistical caliber is the full data under current filter conditions, unaffected by PageNumber/PageSize.

ListWorkflowTaskRunsRsp

to the workflow task running list query.

Used by actions: ListWorkflowTaskRuns.

Name Type Required Description
PageNumber Integer No Current page
PageSize Integer No Page Size
TotalCount Integer No Total number of records
TotalPageNumber Integer No Total pages
Items Array of WorkflowTaskRun No Task execution history list

ListWorkflowsRsp

ListWorkflowsRsp

Used by actions: ListWorkflows.

Name Type Required Description
PageNumber Integer No Current page
PageSize Integer No Page Size
TotalCount Integer No Total number of records
TotalPageNumber Integer No Total pages
Items Array of WorkflowBrief No Workflow list

ListWorkspaceGroupsRsp

for querying the list of user groups in a workspace

Used by actions: ListWorkspaceGroups.

Name Type Required Description
Items Array of WorkspaceGroupInfo No User group list
PageNumber Integer No Current page
PageSize Integer No Page Size
TotalCount Integer No Total number of records
TotalPageNumber Integer No Total pages

ListWorkspaceUsersRsp

to the query for the list of users in the workspace

Used by actions: ListWorkspaceUsers.

Name Type Required Description
Items Array of WorkspaceUserInfo No User list.
PageNumber Integer No Current page
PageSize Integer No Page Size
TotalCount Integer No Total number of records
TotalPageNumber Integer No Total pages
ExtendInfo String No Extended information (returned by the server in consecutive pagination scenarios; include it as is in the next pagination request)

ListWorkspacesRsp

to the query for the workspace list

Used by actions: ListWorkspaces.

Name Type Required Description
Items Array of WorkspaceInfo No

Workspace list.
PageNumber Integer No

Current page
PageSize Integer No

Page Size
TotalCount Integer No

Total number of records
TotalPageNumber Integer No

Total number of pages
IsConsoleAdmin Boolean No

Console administrator or not

MetaOwner

Metadata responsible person information data structure

Used by actions: CreateSchema, GetCatalog, ListCatalogs, ListSchemas.

Name Type Required Description
FullName String No Metadata name (full name): catalog.schema.table
OwnerType String No Owner type: User
Owner String No Owner: Unique ID (uin)
OwnerName String No Owner name.

MonitorMetricBrief

Monitoring metrics configuration

Used by actions: CreateWorkflow, GetWorkflow, UpdateWorkflow.

Name Type Required Description
MonitorMetricId String No Monitoring metric ID. No need to import upon creation, as it is generated by the server.
AlarmMonitorType String No Monitored object type of the alarm, such as workflow or task. Currently supported: 1. WORKFLOW 2. TASK
Metrics Array of MonitorMetricItem No Monitoring Metrics List

MonitorMetricItem

Single monitoring metric

Used by actions: CreateWorkflow.

Name Type Required Description
MetricType String No Monitoring Metric Types. There are three types: 1. RUN_DURATION (running time) 2. WAIT_DURATION (waiting duration) 3. COMPLETION_TIME (completion time)
WarningThreshold String No Alarm threshold in milliseconds. For COMPLETION_TIME: calculated from 00:00 of the current day.
TimeoutThreshold String No Timeout threshold in milliseconds. For COMPLETION_TIME, it is calculated from 00:00 of the current day.

OrderBy

Sorting field.

Used by actions: ListConsoleGroupUsers, ListConsoleGroups, ListConsoleUsers, ListFiles, ListWorkflowRuns, ListWorkflows, ListWorkspaceGroups, ListWorkspaceUsers, ListWorkspaces.

Name Type Required Description
Direction String No Sorting order. Asc (ascending order) or Desc (descending order). Not case-sensitive.
Name String No Sort field name

ParamInfo

Parameter key-value pair

Used by actions: CreateWorkflow, GetWorkflow, UpdateWorkflow.

Name Type Required Description
ParamId String No Parameter ID, no need to import upon creation; generated by the server
ParamKey String No Parameter name.
ParamValue String No Parameter value.

PermissionDetail

Entity permission information, for returning the current user's list of permissions for an entity in get/list APIs.

Used by actions: CreateSchema, GetCatalog, ListCatalogs, ListSchemas.

Name Type Required Description
Permissions Array of String No Permission list of the current user for this entity.
CatalogWorkspacePrivilege String No Permission information of the catalog on the workspace (optional). Value: WORKSPACE_READONLY (read-only) or WORKSPACE_READWRITE (read-write).
DenyPrivilegeList Array of String No Total deny permission list (user deny ∪ role deny ∪ inherited deny, deduplicated and excluded from Permissions)

PlatformStatusRsp

Common bool return

Used by actions: AddWorkspaceGroups, AddWorkspaceUsers, RemoveWorkspaceGroups.

Name Type Required Description
Status Boolean No Universal return

RemoveConsoleUsersRsp

to batch removal of console users

Used by actions: RemoveConsoleUsers.

Name Type Description
Status Boolean

The request has been processed; true even if partially failed. For individual results, refer to SuccessUins/FailItems.
SuccessUins Array of String

List of successfully deleted User UINs
FailItems Array of CommonFailItem

List of failed items (Item is the user UIN, and FailReason is the failure reason).

ResourceGroupInfo

Resource group information

Used by actions: GetWorkflowRun, GetWorkflowTaskRun, ListWorkflowRuns, ListWorkflowTaskRuns, ListWorkflows.

Name Type Required Description
ResourceGroupId String No

Resource group ID
ResourceGroupName String No

Resource group name.
ResourceGroupStatus String No

Resource group status

Parameter format: 0 // not specified 1 // to be created 2 // creating 3 // running 4 // stopped 5 // stopping 6 // starting 7 // updating 8 // deleting 9 // deleted 10 // user proactive start / automatic startup (task submitted and auto start/stop enabled) 11 // available: unique to data computing 12 // unavailable: unique to data computing 13 // failure

RoleBasicInfo

Basic role information

Used by actions: CreateWorkspaceRole, ListConsoleGroups, ListConsoleRoles, ListConsoleUsers, ListWorkspaceGroups, ListWorkspaceUsers, UpdateWorkspaceRole.

Name Type Required Description
Id String No

Role ID, can be obtained through the ListWorkspaceRoles / ListConsoleRoles API; not required when creating/updating a role (automatically generated by the system, retrieved from Data.RoleId in the response after successful creation)
Name String No

Role name.
Description String No

Character description.
DisplayName String No

Display name.
RoleType String No

Role type: workspace=workspace system role, workspace_custom=workspace custom role, console=console role; returned when querying, not required upon creation (the system creates a custom role by default)
Source Integer No

Role source (query-side field, not required upon creation): 0=not specified, 1=directly bound to user, 2=inherited from user group, 3=Both
GroupNames Array of String No

List of user group names inherited from the source (query-side field, not required upon creation). Empty when Source=1

RoleMetaData

Role metadata

Used by actions: ListConsoleRoles.

Name Type Description
Creator String Creator.
CreateTime String Creation time.
Updater String Updater
UpdateTime String Update time.

RolePermission

Role permission

Used by actions: CreateWorkspaceRole, ListConsoleRoles, UpdateWorkspaceRole.

Name Type Required Description
ModuleId String No

Module ID, which must be the module ID of a feature module (leaf node) activated for the current tenant (hierarchical encoded string, for example 101=quick start, 109=workflow, 116101103=workspace management_role permission). An illegal value returns InvalidParameterValue. Method for obtaining the module list: call the ListWorkspaceModules API to query the workspace module list, and take the returned Items[].ModuleId field (leaf nodes with IsLeaf set to true). You can also view it on the "Workspace settings-Role permission" page in the console.
Permissions String No

Module access permission. Single value: R=read-only, RW=read-write, RWD=read and write delete, N=no permission

RunActionBrief

Outcome of a single operation. Shared by RunWorkflow / RerunWorkflowRun / KillWorkflowRun: RunWorkflow — WorkflowId / WorkflowName have values, WorkflowRunId is empty. RerunWorkflowRun — WorkflowId / WorkflowName / WorkflowRunId all have values. KillWorkflowRun — WorkflowId / WorkflowName / WorkflowRunId all have values.

Used by actions: KillWorkflowRun, RerunWorkflowRun, RunWorkflow.

Name Type Required Description
WorkflowId String No Workflow ID
WorkflowName String No Workflow name.
RunActionId String No Operation action ID, used to trace the specific executed action.
ErrorMessage String No Failure error message. When the operation fails, a specific error description is returned.
OpStatus Boolean No Operation status. true indicates success, and false indicates failure.
WorkflowRunId String No Workflow running ID. In rerun/termination scenarios, the operated running ID is returned. It is empty in the run workflow scenario.

ScheduleBizEnumBrief

Enumeration item statistics (such as quantity distribution of running states and error codes)

Used by actions: GetWorkflowTaskRun, ListWorkflowRuns.

Name Type Required Description
LabelKey String No Enumerate tag keys
LabelValue String No Enumerate tag values.
Count Integer No Statistical quantity of enumeration items

ScheduledTimeConfig

Scheduling time configuration

Used by actions: RerunWorkflowRun, RunWorkflow.

Name Type Required Description
ScheduledTimeZone String No

Scheduling time zone, IANA time zone ID
StartTime String No

Start of effective scheduling time

Parameter format: timestamp in milliseconds (UTC)
EndTime String No

Scheduling expiration time

Parameter format: millisecond timestamp (UTC)
CycleType String No

Cycle type

Enumeration values:

  • DAY_CYCLE: Day
  • HOUR_CYCLE: Hour
  • MINUTE_CYCLE: Minute
  • WEEK_CYCLE: Week
CycleNum Integer No

Period step

Schema

Schema information

Used by actions: CreateSchema, ListSchemas.

Name Type Required Description
Name String Yes

schema name
Comment String No

Description. Note: This field may return null, indicating that no valid values can be obtained.
Properties Array of KVPair No

Property. Note: This field may return null, indicating that no valid value can be obtained.
Audit Audit No

Audit information. Note: This field may return null, indicating that no valid value can be obtained.
MetaOwner MetaOwner No

owner information.
AssetGuid String No

Globally unique asset ID, generated by WedataAssetUIDUtils.generateUID
PermissionDetail PermissionDetail No

Permission information of the current user on this schema. Note: This field may return null. It is not returned if FetchPermissions is not enabled in the request.
Tags Array of CommonTagInfo No

Tag information list. Note: This field may return null and is not returned if FetchTags is not enabled in the request.

SparseCheckoutConfig

git checkout rules

Used by actions: CreateFolder.

Name Type Required Description
Enabled Boolean No

Whether to enable sparse detect
ConeMode Boolean No

Whether to use cone mode (true recommended for greater efficiency in directory matching)
Patterns Array of String No

Sparse checkout path list (for example, ["src/module-a/", "docs/"])

StandardUserInfo

Basic display information of the user

Used by actions: GetWorkspace, ListWorkspaces.

Name Type Required Description
UserUin String No User UIN.
UserName String No Username.
Nickname String No Nickname
UserTag String No 0: general user; 1: Entra ID user.

StartComputeRsp

Start up the computational resource and return the result.

Used by actions: StartCompute.

Name Type Description
Status Boolean Whether the operation is successful

StopComputeRsp

Terminate the computational resource and return the result.

Used by actions: StopCompute.

Name Type Description
Status Boolean Whether the operation is successful

TagValueInfo

Tag value information

Used by actions: ListWorkspaceGroups, ListWorkspaceUsers.

Name Type Required Description
TagValueId String No Tag value ID
TagValue String No Tag value content. Fill in when querying. Do not pass in when writing.
Source Integer No Tag source. See web_enum_standard.proto -> TagSource: 0=not specified 1=directly bound to user 2=inherited from user group 3=both. Populated during queries. Do not pass when writing.
GroupNames Array of String No List of user group names from the inheritance source. Empty when Source=1. Populated during queries. Do not pass when writing.

TaskRetryStrategy

Task retry policy

Used by actions: CreateWorkflow, ListWorkflows.

Name Type Required Description
MaxRetryTimes Integer No Maximum retry count. Default value: 3.
RetryBetweenWaitTime Integer No Waiting time between retries. Default value: 5
RetryBetweenWaitTimeUnit String No Time unit to wait between retries
ms: MILLISECOND second: SECOND minute (default): MINUTE hour: HOUR
TaskRunFailureRetrySwitch Boolean No Retry switch when task running fails. true by default.
TaskRunTimeoutRetrySwitch Boolean No Retry switch for task timeout, false by default

TaskRunConditionRule

Task run condition rules

Used by actions: CreateWorkflow.

Name Type Required Description
UpstreamTaskId String No

Upstream task ID
UpstreamTaskName String No

Upstream task name
AllowedStates Array of String No

Task run conditions
Supported status values: - SUCCESS: successful - FAILED: failed - UPSTREAM_FAILED: upstream failed - EXCLUDED: excluded from running

TaskSchedulingParameterBrief

Task scheduling parameter (custom parameter for running or rerunning a workflow)

Used by actions: RerunWorkflowRun, RunWorkflow.

Name Type Required Description
ParamKey String No Parameter name.
ParamValue String No Parameter value.

TaskType

In TaskTypePropertyList, TaskTypeProperty requires filling in different keys and values for different task types;

1. NOTEBOOK task type

Attribute configuration

Attribute key Attribute name Description Required
Source Source Supports only 2 or 5. Source 2: GIT, 5: workspace Yes
NotebookPath Notebook relative path If Source is 5, obtain it from ListFiles Required if Source is 2 or 5

2. DATA_INTEGRATION task type

Attribute configuration

Attribute key Attribute name Description Required
Source Source Required: 4. Indicates the source is COS. Yes
TemplatePath Data access task configuration path Obtain through the ListBatchIngestionTasks API Yes
DataIntegrationTaskId Data access task ID Obtain through the ListBatchIngestionTasks API Yes

3. RUN_WORKFLOW task type

Attribute configuration

Attribute Key Attribute Name Description Required
WorkflowId Select workflow Obtain through the API (ListWorkflows) Yes

4. SQL task type

Attribute configuration

Attribute key Attribute name Description Required or not
Source Source Supports only 2 or 5. Source 2: GIT, 5: workspace Yes
SqlPath SQL script path SQL script path Required when Source is 2
CodeFileName File name When Source is 5, obtain through the ListReleasedQueries API No
CodeFileId File ID When Source is 5, obtain through the ListReleasedQueries API Required when Source is 5
CodeFileVersion File version When Source is 5, obtain through the ListReleasedQueries API No

5. PYTHON task type

Attribute configuration

Attribute key Attribute name Description Required or not
Source Source Supports only 2 or 5. Source 2: GIT, 5: workspace Yes
SourcePath Python script path When Source is 5, obtain through the ListFiles API Yes

6. DATA_QUALITY (quality monitoring) task type

Attribute configuration

Attribute key Attribute name Description Required
Source Source Required: 4. Indicates the source is COS. Yes
TemplatePath Quality monitoring configuration path Must be obtained through the ListDataQualityTaskSummaries API Yes
SourceUniqueId Quality monitoring ID It needs to be obtained through the ListDataQualityTaskSummaries API. Yes
ExecutionType Execution type Required: SQL Yes
AfterAspect Post-aspect of quality task Obtain through the ListDataQualityTaskSummaries API No
BeforeAspect Front aspect of the quality task Obtain through the ListDataQualityTaskSummaries API No

7. IF_ELSE task type

Attribute configuration

Attribute Key Attribute Name Description Required
Conditions Condition list IF-ELSE conditional configuration Yes

8. FOR_EACH task type

Attribute configuration

Attribute key Attribute name Description Required
MaxConcurrency Maximum concurrency number Maximum concurrency number, default value: 1 Yes
MaxIterations Maximum number of iterations Maximum number of iterations. Default value: 1000. Yes
LoopDataArray Loop parameter Array in JSON format, or variable wrapped in {{}} Yes

9. RAY_JOB (Ray job) task type

Attribute configuration

Attribute key Attribute name Description Required
RunMode Running mode Running mode. Value: SERVERLESS (pull up a cluster as needed) / DEDICATED (submit to a specified cluster). Default: DEDICATED Yes
Entrypoint Entry command Entry command Yes
JobConfig Task configuration For example, storage configuration + computing environment. To pass the value, refer to the UpdateWorkflow API call when saving a Ray job task on the frontend page. For Image, call the DLC ListImages API and get the API Url field Required when RunMode is SERVERLESS
ClusterId Ray cluster Select from the list of configured Ray clusters (engines) under the selected computational resource. Obtain through the computational resource API. Required when RunMode is DEDICATED
Source Task source Task source. Value: 1 (local file) / 5 (workspace) Yes
JobPackage Task source file address Task source path: if Source is 1, the COS address of the uploaded local file (supports .zip / .py files); if Source is 5, the path of the selected workspace file/folder Yes
JobPackageName Local file name of the task source Local file name of the task source Required when Source is 1
CodeFileId Code file ID When Source is 5, get the ID of the selected file/folder from the workspace file selection component Required when Source is 5
WorkspaceEntryType Workspace entry type When Source is 5, the type of the selected workspace entry: FILE / FOLDER, auto-written by the frontend selector based on the selected target Required when Source is 5

RuntimePropertyList

Task running parameter list, used to configure computing resources when the task is running. It is case-sensitive from TaskTypePropertyList (task extended attribute): TaskTypePropertyList carries the business configuration of the task itself (such as script source, path), while RuntimePropertyList carries the resource configuration when the task is running (such as resource mode, CU specification, number of Executors).

Mainly suitable for task types that require configuring computing resources (such as NOTEBOOK and PYTHON).

Specific fillable attribute keys are configured as standard based on the task type attribute configuration. You can obtain them through the ListWorkflowTaskTypeProperties API (attribute items with propertyType as RUNTIME). Common running parameter key descriptions:

Attribute key Attribute name Description Required (when the linkage condition is met) Default value
ResourceMode Resource mode 1: distributed; 2: single-node Yes 1
ConfigType Configuration type DEFAULT: default configuration; CUSTOM: custom configuration Yes DEFAULT
ExecutorAllocation Executor allocation mode DYNAMIC: dynamic allocation; FIXED: fixed allocation Yes (when distributed and custom configuration is used) DYNAMIC
ExecutorMinNum Minimum number of executors Positive integer Yes (for dynamic allocation) 1
ExecutorMaxNum Maximum number of executors Positive integer Yes (for dynamic allocation) 1
ExecutorFixedNum Fixed number of executors Positive integer No (for fixed allocation) -
ExecutorCU Executor resource specification small / medium / large / xlarge / 4xlarge No (for distributed with custom configuration) -
DriverCU Driver resource specification small / medium / large / xlarge / 4xlarge No (for distributed with custom configuration or single-node) -
ExecutorGPU Number of Executor GPUs 0 means non-use of GPUs No (for distributed with custom configuration) -
DriverGPU Number of driver GPUs 0 means non-use of GPUs No (for distributed and custom configuration) -
Style Configuration style UI / JSON Yes (for custom configuration) UI

Supplemental description:

1. "Required" refers to the required tag in property configuration. Required verification is triggered only when the property linkage conditions (for example, ResourceMode=1 and ConfigType=CUSTOM) are met;

2. When ConfigType is DEFAULT, call the ListComputeResourceOptions API to obtain the default specification value of the selected computational resource, and bind it to the running parameters (ExecutorCU, DriverCU, ExecutorMinNum, ExecutorMaxNum, etc.) before input. When ConfigType is CUSTOM, the running parameters are specified by the caller.

Used by actions: CreateWorkflow.

Name Type Required Description
TaskTypeName String No

Task type: SQL: for executing SQL queries and data processing operations; DATA_INTEGRATION: for offline data access operations; NOTEBOOK: used to run Notebook scripts; RUN_WORKFLOW: for executing nested workflows; PYTHON: used to run Python scripts; RAY_JOB: used to run Ray jobs; DATA_QUALITY: for data quality monitoring; IF_ELSE: for conditional branch judgment; FOR_EACH: for loop traversal execution;
TaskTypePropertyList Array of TaskTypeProperty No

List of task extended attributes. For details, see the description of TaskType.TaskPropertyList.
RuntimePropertyList Array of TaskTypeProperty No

Runtime attribute list. For specific values, fill in reference to the TaskType.RuntimePropertyList description

TaskTypeProperty

Task type attribute key-value pair

Used by actions: CreateWorkflow.

Name Type Required Description
PropertyKey String No

Attribute key name. When used as an input parameter in TaskType, if it is not passed or is empty, this attribute item is silently ignored by the server (no error reported), equivalent to the attribute being unconfigured. For the list of valid PropertyKey, see the description in TaskType.
PropertyValue String No

Attribute value.

UnbindWorkflowBundleRsp

UnbindWorkflowBundleRsp

Used by actions: UnbindWorkflowBundle.

Name Type Required Description
Status Boolean No Operation status. true indicates success.

UpdateConsoleGroupRsp

of modifying a console user group

Used by actions: UpdateConsoleGroup.

Name Type Description
Status Boolean Whether the operation is successful

UpdateConsoleUsersRsp

of modifying a console user

Used by actions: UpdateConsoleUsers.

Name Type Description
Status Boolean Whether the operation is successful

UpdateFolderRsp

Response for folder update

Used by actions: UpdateFolder.

Name Type Required Description
Status Boolean No

Result of updating the folder. true: Success

UpdateWorkflowRsp

UpdateWorkflowRsp

Used by actions: UpdateWorkflow.

Name Type Required Description
Status Boolean No Update status. true indicates success.

UpdateWorkspaceRoleResult

Result of updating a workspace role

Used by actions: UpdateWorkspaceRole.

Name Type Description
Status Boolean Whether the workspace role is updated successfully

UpdateWorkspaceRsp

to workspace modification

Used by actions: UpdateWorkspace.

Name Type Required Description
Status Boolean No Whether the operation is successful

UserInfo

Basic user information

Used by actions: GetFolder, ListFiles.

Name Type Required Description
UserUin String No

uin
UserName String No

Sub-user name
Nickname String No

Sub-user nickname
UserTag String No

0: general user 1: entraId user

UserTagInfo

User/user group tag dimensions (independent structure in the user management domain, decoupled from common TagInfo, for use only by user/user group tag APIs)

Used by actions: ListWorkspaceGroups, ListWorkspaceUsers.

Name Type Required Description
TagId String No

Tag dimension ID
TagName String No

Tag name, filled during queries, not passed when writing
Values Array of TagValueInfo No

All tag values bound to this dimension

Workflow

Complete workflow configuration

Used by actions: UpdateWorkflow.

Name Type Required Description
WorkspaceId String No

Workspace ID, which can be obtained through ListWorkspaces.
BaseInfo WorkflowBaseInfo No

Workflow basic info
Trigger Array of WorkflowTriggerConfiguration No

Workflow scheduling configuration.
ParamList Array of ParamInfo No

Workflow parameter list. The parameter name is required and can only contain digits, upper- and lower-case letters, spaces, .$@#!%^&*()-_+=>. It can contain up to 128 characters.
LabelList Array of LabelBrief No

Tag tag name is required and can only contain digits, upper- and lower-case letters, spaces, .$@#!%^&*()-_+=>', up to 128 characters
Alarm AlarmBrief No

Workflow alert configuration.
MonitorMetric MonitorMetricBrief No

Monitoring metrics configuration
AdvanceConfig WorkflowAdvanceConfig No

Workflow advanced setting.
TaskList Array of WorkflowTask No

Workflow task list
BundleId String No

BundleId, obtainable through the Bundle API
BundleInfo String No

Bundle information
GitConfigId String No

GIT configuration ID, corresponding to ConfigKey in the GetWorkspaceConfig API
GitBranch String No

Git branch information.

WorkflowAdvanceConfig

Workflow advanced setting.

Used by actions: CreateWorkflow, GetWorkflow, UpdateWorkflow.

Name Type Required Description
QueuingMode String No Queue mode. ON (default) and OFF.
MaxConcurrentNum Integer No
The default value is 1.

When QueuingMode is ON, the MaxConcurrentNum setting takes effect. Input only integers larger than 0. Invalid input is automatically converted to 1.

WorkflowBaseInfo

Workflow basic info (for input parameters)

Used by actions: CreateWorkflow, UpdateWorkflow.

Name Type Required Description
WorkflowName String No Workflow name, length not exceeding 1024
WorkflowId String No Workflow ID. No need to import upon creation, as it is generated by the server.
RunUserUin String No UIN of the person who runs the workflow
Description String No Description
OwnerUserName String No Workflow owner userName.

WorkflowBaseInfoDetail

Workflow basic info (for output parameters, including system-generated fields and owner display information)

Used by actions: GetWorkflow.

Name Type Required Description
WorkflowName String No Workflow name.
WorkflowId String No Workflow ID
CreateUserUin String No Creator UIN
RunUserUin String No UIN of the person who runs the workflow
Description String No Description
OwnerUserName String No Workflow owner userName
OwnerUserUin String No Workflow owner UIN
OwnerDisplayName String No Display name of the workflow owner
CreateTime String No Creation time. Unit: millisecond timestamp
UpdateTime String No Last update time. Unit: timestamp in milliseconds

WorkflowBrief

Workflow list item

Used by actions: ListWorkflows.

Name Type Required Description
WorkflowName String No

Workflow name
WorkflowId String No

Workflow ID
Description String No

Description.
CreateUserUin String No

Creator UIN
OwnerUserName String No

Workflow owner userName
OwnerUserUin String No

Workflow owner UIN
OwnerDisplayName String No

Display name of the workflow owner
CreateTime String No

Creation time. Unit: millisecond timestamp
UpdateTime String No

Last update time. Unit: timestamp in milliseconds
LabelList Array of LabelBrief No

Tag list.
Trigger Array of WorkflowTriggerConfiguration No

Workflow scheduling configuration.
RunUserUin String No

Workflow runner UIN
RunUserName String No

Workflow runner userName
TaskList Array of WorkflowTaskNodeBrief No

Workflow task node list
WorkflowRunList Array of WorkflowRunBrief No

Workflow running status list
ResourceGroupInfoList Array of ResourceGroupInfo No

Resource group information list.
Permission String No

Authorization permission type
PERMISSION_TYPE_UNSPECIFIED: unspecified permission
MANAGE: management permission, including all operation permissions
RUN: execution permission, executable entity
VIEW: view permission, viewable entity content
BundleId String No

Unique ID of the Bundle bound to the workflow. Empty if not bound
BundleInfo String No

Bundle information
GitConfigId String No

Git configuration ID.
GitBranch String No

Git branch information.

WorkflowRun

Workflow running information

Used by actions: GetWorkflowRun, ListWorkflowRuns.

Name Type Required Description
AppId String No

Root account ID
WorkflowName String No

Workflow name
WorkflowId String No

Workflow ID
WorkflowRunId String No

Workflow running ID
WorkspaceId String No

Workspace ID
TriggerType String No

Trigger mode: Scheduler, ManualTrigger, Event (for reference, see SchedulerTriggerType)
RunStartTime String No

Start time in milliseconds.
PendingStartTime String No

Start time of the pending state, unit: timestamp in milliseconds
QueueStartTime String No

queue status start time, unit: timestamp in milliseconds
RunEndTime String No

Running end time, unit: timestamp in milliseconds
EndTime String No

End time. It has a value when running enters the end state. Unit: timestamp in milliseconds
RunCostTime String No

Running time, unit: seconds
QueueCostTime String No

Concurrency queue time, in seconds
PendingCostTime String No

Time spent waiting for resources, in seconds
RunState String No

RUNNING state. CREATE("initialization"), QUEUED("Waiting"), PENDING("preparing"), RUNNING("RUNNING"), SKIPPED("skip RUNNING"), SUCCESS("successful"), FAILED("failure"), TERMINATING("TERMINATING"), TERMINATED("termination"), CANCELLED("manual termination"), etc.
ResourceGroupIds Array of String No

Computational resource (resource group ID set of the task)
RunUserUin String No

Running user UIN
RunUserName String No

Username for operation
ErrorCodeString String No

Error code
WorkflowParams String No

Running parameter
WorkflowVersionId String No

Workflow version ID
SupportRerun Boolean No

Whether rerunning is supported for the current workflow
CreateTime String No

Workflow run creation time. Unit: millisecond timestamp
RerunTimes Integer No

Number of reruns.
SelectedTaskIds Array of String No

Task scope in operation, Task ID list
ResourceGroupInfoList Array of ResourceGroupInfo No

Resource group information list.
LabelList Array of LabelBrief No

Tag list.
ParentWorkflowRunId String No

Parent workflow running ID [unique to nested workflow triggers]
ParentWorkflowTaskRunId String No

Parent workflow task running ID [unique to nested workflow triggers]
ParentWorkflowTaskRunName String No

Parent workflow task run name [exclusive to nested workflow triggers]
Permission String No

Authorization permission type
PERMISSION_TYPE_UNSPECIFIED: unspecified permission
MANAGE: management permission, including all operation permissions
RUN: execution permission, executable entity
VIEW: view permission, viewable entity content
AdvancedParameters Array of AdvancedParameter No

Parameters filled in by the user during advanced execution of the workflow
ScheduledTime String No

Scheduled dispatch time

Parameter format: timestamp in milliseconds (UTC)

WorkflowRunBrief

Operating status of the workflow list item

Used by actions: ListWorkflows.

Name Type Required Description
WorkflowRunId String No Workflow running ID
RunStartTime String No Start time in milliseconds.
RunState String No

RUNNING state. CREATE("initialization"), QUEUED("Waiting"), PENDING("preparing"), RUNNING("RUNNING"), SKIPPED("skip RUNNING"), SUCCESS("SUCCESS"), FAILED("failure"), TERMINATING("TERMINATING"), TERMINATED("termination"), CANCELLED("manual termination"), etc.
ErrorCodeString String No Runtime error code

WorkflowTask

Workflow task information. Note: This structure is used for both input parameters (CreateWorkflow / UpdateWorkflow) and output parameters (GetWorkflow). CreateTime / UpdateTime / CreateUserUin are system-generated fields that only have values in output parameters. Values passed in input parameters do not take effect (ignored by the server with no error reported).

Used by actions: CreateWorkflow, GetWorkflow, UpdateWorkflow.

Name Type Required Description
ParamList Array of ParamInfo No Task parameters.
DependOnList Array of DependOnBrief No Task dependency
TaskId String No Task ID. No need to import upon creation as it is generated by the server.
TaskName String No Task name.
TaskType TaskType No Task type
ResourceGroupId String No Resource group ID, which can be obtained through the resource group related API.
Description String No Task description
Alarm AlarmBrief No Task alert
MonitorMetric MonitorMetricBrief No Monitoring metrics
TaskRetryStrategy TaskRetryStrategy No Task retry policy
DependOnRunCondition String No

Any dependency run condition

  • ALL_SUCCESS: All successful: All upstream dependency tasks have been executed and succeeded
  • ONE_SUCCESS: At least one successful: At least one upstream dependency task succeeded
  • NONE_FAILED: No failure currently: No dependency task failed, and at least one dependency task is running
  • ALL_DONE: All completed: All upstream dependency tasks have been executed and completed (regardless of success or failure
  • ONE_FAILED: At least one failed: At least one upstream dependency task failed
  • ALL_FAILED: All failed: All upstream dependency tasks failed
  • ALL_DONE_AT_LEAST_ONE_SUCCESS: All upstream completed and at least one successful: When all upstream dependency tasks reach a final state, perform dependency check. If at least one succeeded, the dependency check passes; otherwise, skip running
  • ALL_SKIPPED: All upstream completed, no skip running: When all upstream dependency tasks reach a final state, perform dependency check. If all upstream states are success, failure, or upstream failed state, the dependency check passes; otherwise, skip running
  • ONE_DONE: At least one completed: As long as one upstream task is completed, perform dependency check, and the dependency check passes; otherwise, keep waiting for upstream
  • ALL_DONE_NONE_FAILED_AT_LEAST_ONE_SUCCESS: All upstream completed, none failed, at least one successful: When all upstream dependency tasks reach a final state, perform dependency check. If no upstream task failed and at least one succeeded, the dependency check passes; otherwise, skip running
  • NONE_SKIPPED: All upstream completed, no skip running: When all upstream dependency tasks reach a final state, perform dependency check. If all upstream states are success, failure, or upstream failed state, the dependency check passes; otherwise, skip running
  • ALL_DONE_AT_LEAST_ONE_FAILED: All upstream completed and at least one failed: When all upstream dependency tasks reach a final state, perform dependency check. If at least one failed, the dependency check passes; otherwise, skip running
  • ADVANCED: Configured when the run condition is in advanced mode
LeftCoordinate Float No X coordinate of the task
TopCoordinate Float No Task Y-axis coordinate
AdvancedDependencyConfig AdvancedDependencyConfig No

Advanced running parameter of the task, configured when DependOnRunCondition is ADVANCED
InnerTask WorkflowTask No

Built-in tasks (subtasks of FOR_EACH tasks)
CreateTime String No

Creation time, unit: timestamp in milliseconds. System-generated field, returned only as an output parameter. No need to import it as an input parameter (importing it does not take effect; the server ignores it and no error is reported)
UpdateTime String No

Update time, unit: millisecond timestamp. System-generated field, returned only in output parameters, no need to import in input parameters (import does not take effect, ignored by the server with no error reported)
CreateUserUin String No

Creator UIN. System-generated field, returned only as an output parameter, no need to import as an input parameter (import does not take effect, ignored by the server with no error reported)

WorkflowTaskNodeBrief

Brief information of workflow task nodes in a workflow list item

Used by actions: ListWorkflows.

Name Type Required Description
WorkflowId String No

Workflow ID
TaskId String No

Task ID.
TaskName String No

Task name.
TaskTypeName String No

Task Type Name. For details, see the TaskTypeName field description in the data structure TaskType.
DependOnList Array of DependOnBrief No

Task dependency list.
ResourceGroupId String No

Task resource group ID.
ResourceGroupName String No

Task resource group name.
LeftCoordinate Float No

Task X coordinate
TopCoordinate Float No

Task Y-axis coordinate
TaskRetryStrategy TaskRetryStrategy No

Task retry policy
DependOnRunCondition String No

Task dependency run conditions

ALL_SUCCESS: All successful: All upstream dependency tasks have been executed and succeeded
ONE_SUCCESS: At least one successful: At least one upstream dependency task succeeded
NONE_FAILED: No failure currently: No dependency task failed, and at least one dependency task is running
ALL_DONE: All completed: All upstream dependency tasks have been executed and completed (regardless of success or failure)
ONE_FAILED: At least one failed: At least one upstream dependency task failed
ALL_FAILED: All failed: All upstream dependency tasks failed
ALL_DONE_AT_LEAST_ONE_SUCCESS: All upstream completed and at least one successful: When all upstream dependency tasks reach a final state, a dependency check is performed. If at least one succeeded, the dependency check passes; otherwise, the run is skipped
ALL_SKIPPED: All upstream completed, no skipped run: When all upstream dependency tasks reach a final state, a dependency check is performed. If all upstream states are successful, failed, or upstream failed state, the dependency check passes; otherwise, the run is skipped
ONE_DONE: At least one completed: Once at least one upstream task is completed, a dependency check is performed, and the dependency check passes; otherwise, it keeps waiting for upstream
ALL_DONE_NONE_FAILED_AT_LEAST_ONE_SUCCESS: All upstream completed, none failed, at least one successful: When all upstream dependency tasks reach a final state, a dependency check is performed. If no upstream task failed and at least one succeeded, the dependency check passes; otherwise, the run is skipped
NONE_SKIPPED: All upstream completed, no skipped run: When all upstream dependency tasks reach a final state, a dependency check is performed. If all upstream states are successful, failed, or upstream failed state, the dependency check passes; otherwise, the run is skipped
ALL_DONE_AT_LEAST_ONE_FAILED: All upstream completed and at least one failed: When all upstream dependency tasks reach a final state, a dependency check is performed. If at least one failed, the dependency check passes; otherwise, the run is skipped
ADVANCED: Configured when the run condition is in advanced mode
AdvancedDependencyConfig AdvancedDependencyConfig No

Advanced dependency configuration
InnerTask WorkflowTaskNodeBrief No

Built-in workflow task node

WorkflowTaskRun

Workflow task running information

Used by actions: ListWorkflowTaskRuns.

Name Type Required Description
TaskName String No

Task name.
WorkflowTaskRunId String No

Task running ID
RunState String No

Running state, for example, CREATE("initialize"), QUEUED("Waiting"), PENDING("preparing"), RUNNING("running"), SKIPPED("skip running"), SUCCESS("success"), FAILED("failure"), TERMINATING("terminating"), TERMINATED("termination"), CANCELLED("manual termination")
WorkspaceId String No

Workspace ID
WorkflowId String No

Workflow ID
WorkflowRunId String No

Workflow running ID
TaskId String No

Task ID.
TaskTypeName String No

Task Type Name. For details, see the description of the TaskTypeName field in the TaskType data structure.
TaskVersionId String No

Task version ID.
TriggerType String No

Trigger type

Enumeration values:

  • Manual: manual triggering
  • Scheduler: scheduling trigger
ResourceGroupId String No

Associated resource group ID
ErrorCodeString String No

Error code
RunUserUin String No

Running user UIN
RunUserName String No

Username for operation
CreateUserUin String No

Creator UIN
JobId String No

Execution platform execution ID
CreateTime String No

Creation time. Unit: millisecond timestamp
UpdateTime String No

Last update time. Unit: timestamp in milliseconds
DependenceFinishedTime String No

Dependency task completion time, unit: timestamp in milliseconds
RunStartTime String No

Start time in milliseconds.
RunEndTime String No

Running end time, unit: timestamp in milliseconds
RunCostTime String No

Running time, unit: seconds
WaitTime String No

Waiting duration (waiting duration from dependency readiness to start), unit: second
IssueTime String No

Execution platform time, unit: timestamp in milliseconds
TimeZone String No

Time zone
DependOnList Array of String No

Task ID list that it depends on. Reserved field, temporarily returns []

Reserved field, temporarily returns []
RunParams String No

Running parameter
TaskTypeExtensions String No

Task extension information, including script path
LeftCoordinate Float No

Task X coordinate
TopCoordinate Float No

Task Y-axis coordinate
RetryTimes Integer No

Number of retries. 0 indicates the first run.
WorkflowName String No

Workflow name
RerunTimes Integer No

Number of reruns.
IsLatestRun Boolean No

Whether it is the most recent run
ResourceGroupInfoList Array of ResourceGroupInfo No

Resource group information list.
RunResult String No

Execution result
DependOnRunCondition String No

Task dependency run conditions

ALL_SUCCESS: All successful: All upstream dependency tasks have been executed and succeeded
ONE_SUCCESS: At least one successful: At least one upstream dependency task succeeded
NONE_FAILED: No failure currently: No dependency task failed, and at least one dependency task is running
ALL_DONE: All completed: All upstream dependency tasks have been executed and completed (regardless of success or failure)
ONE_FAILED: At least one failed: At least one upstream dependency task failed
ALL_FAILED: All failed: All upstream dependency tasks failed
ALL_DONE_AT_LEAST_ONE_SUCCESS: All upstream completed and at least one successful: When all upstream dependency tasks reach a final state, a dependency check is performed. If at least one succeeded, the dependency check passes; otherwise, the run is skipped
ALL_SKIPPED: All upstream completed, no skipped runs: When all upstream dependency tasks reach a final state, a dependency check is performed. If all upstream states are success, failure, or upstream failed state, the dependency check passes; otherwise, the run is skipped
ONE_DONE: At least one completed: Once any upstream task is completed, a dependency check is performed, and the dependency check passes; otherwise, it keeps waiting for upstream
ALL_DONE_NONE_FAILED_AT_LEAST_ONE_SUCCESS: All upstream completed, none failed, at least one successful: When all upstream dependency tasks reach a final state, a dependency check is performed. If no upstream task failed and at least one succeeded, the dependency check passes; otherwise, the run is skipped
NONE_SKIPPED: All upstream completed, no skipped runs: When all upstream dependency tasks reach a final state, a dependency check is performed. If all upstream states are success, failure, or upstream failed state, the dependency check passes; otherwise, the run is skipped
ALL_DONE_AT_LEAST_ONE_FAILED: All upstream completed and at least one failed: When all upstream dependency tasks reach a final state, a dependency check is performed. If at least one failed, the dependency check passes; otherwise, the run is skipped
ADVANCED: Configured when the run condition is in advanced mode
AdvancedDependencyConfig AdvancedDependencyConfig No

Advanced dependency configuration
InnerTask InnerWorkflowTaskBrief No

Built-in workflow task information
ScheduledTime String No

Scheduled dispatch time

Parameter format: timestamp in milliseconds, UTC

WorkflowTriggerAdvancedConfiguration

Workflow scheduling advanced configuration.

Used by actions: CreateWorkflow.

Name Type Required Description
TaskRetryMode String No

Retry mode for all tasks under the workflow. Valid only when TriggerMode is CONTINUE_RUN.

Enumeration values:

  • onFailure: automatic retry on failure
  • never: do not retry

WorkflowTriggerConfiguration

Workflow scheduling configuration.

Used by actions: CreateWorkflow, GetWorkflow, ListWorkflows, UpdateWorkflow.

Name Type Required Description
TriggerId String No

Scheduling configuration ID. No need to import upon creation as it is generated by the server.
SchedulerStatus String No

Scheduling status Startup: START, Suspension: PAUSE
TriggerMode String No

Trigger mode:

  • Scheduled trigger: TIME_TRIGGER
  • Continuously run: CONTINUE_RUN

Note:

  • In TIME_TRIGGER mode, SchedulerStatus, SchedulerTimeZone, StartTime, EndTime, ConfigMode, CycleType, and CrontabExpression are required;
  • In CONTINUE_RUN mode, AdvancedConfig is required;
SchedulerTimeZone String No

Scheduling time zone
StartTime String No

Scheduling effective time, unit: timestamp in milliseconds. Must be less than EndTime
EndTime String No

Scheduled end time, in milliseconds timestamp. Must be greater than StartTime
ConfigMode String No

Configuration mode. Standard: COMMON. CRON expression: CRON_EXPRESSION
CycleType String No

Cycle type: Supported types: ONEOFF_CYCLE: one-time, YEAR_CYCLE: year, MONTH_CYCLE: month, WEEK_CYCLE: week, DAY_CYCLE: day
HOUR_CYCLE: hour, MINUTE_CYCLE: minute, CRONTAB_CYCLE: crontab expression type
CrontabExpression String No

cron expression
ExtraInfo String No

Json format, for reconciliation
AdvancedConfig WorkflowTriggerAdvancedConfiguration No

Advanced configurations.

WorkspaceGroupInfo

Workspace user group information

Used by actions: ListWorkspaceGroups.

Name Type Required Description
GroupId String No

User group ID
GroupName String No

User group name
Roles Array of RoleBasicInfo No

List of characters.
CreateTime String No

Creation time, timestamp in milliseconds
UpdateTime String No

Update time, millisecond timestamp
UserCount Integer No

Number of users in the user group
GroupType String No

user group type. The value is a string form of an enumerated numeric value: "0" = console system type (including all users), "1" = console custom type, "2" = workspace system type (including all workspace users), "3" = workspace custom type
Tags Array of UserTagInfo No

Tags directly bound to this group (excluding inheritance).

WorkspaceInfo

Workspace information

Used by actions: GetWorkspace, ListWorkspaces.

Name Type Required Description
WorkspaceId String No Workspace ID
WorkspaceName String No Workspace name
Description String No Workspace description
WorkspaceRegion String No Workspace region (for example, ap-guangzhou)
Status Integer No Workspace status: 0=unspecified, 1=creating, 2=creation failed, 3=operating normally, 4=deleted.
ErrorReason String No Failure reason (valid when Status=2, indicating creation failure)
Creator StandardUserInfo No Creator information
CreateTime String No Creation time. Millisecond timestamp
UpdateTime String No Last update time. Timestamp in milliseconds
HasAccess Boolean No Whether the current user has access permission for the workspace

WorkspaceUserInfo

Workspace user information

Used by actions: ListWorkspaceUsers.

Name Type Required Description
UserUin String No

User UIN.
UserName String No

Username.
Nickname String No

Nickname
Roles Array of RoleBasicInfo No

List of characters.
UserSource String No

User source. group: user group, user: user
CreateTime String No

Creation time. Millisecond timestamp
UpdateTime String No

Update time. Millisecond timestamp
IsOwner Boolean No

Root account or not
UserTag Integer No

0: general user 1: entraId user
IsAdmin Boolean No

Whether the sub-account has admin permission
Tags Array of UserTagInfo No

Tags after merge (directly bound to user + inherited from user group)
上一篇: DeleteSchema下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档