Agent information.
Used by actions: DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent.
| Name | Type | Description |
|---|---|---|
| AgentId | String | Agent ID |
| Name | String | Agent name |
| Description | String | Agent description |
| Category | String | Agent Category. |
| Status | String | Status: draft/configured/running/standby/disabled |
| SkillIds | Array of String | List of associated skill IDs. |
| ResourceMapId | String | Associated resource map ID. |
| MCPIds | Array of String | Associated mcp id. |
| CamTags | Array of Tag | Resource Tag. |
| EnvVars | Array of EnvVar | Environment variables required by the agent at runtime |
Alarming Label
Used by actions: DescribeAlarmNotifyHistories.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | label name |
| Value | String | No | label value |
Notification history for each alert
Used by actions: DescribeAlarmNotifyHistories.
| Name | Type | Description |
|---|---|---|
| NotifyId | String | Unique notification ID. |
| PolicyId | String | Alert policy ID |
| SessionId | String | Alarm cycle iD |
| NotifyTime | Integer | Notification time in Unix timestamp (in seconds). |
| TriggerTime | Integer | Trigger time in Unix timestamp (in seconds). |
| TriggerLevel | String | Alarm severity level. Valid values: None, Note, Warn, and Serious. |
| AlarmContent | String | alert content |
| AlarmObject | String | Alarm object |
| ChannelSet | Array of String | Alarm notification channel collection involved this time Note: This field may return null, indicating that no valid values can be obtained. |
| ChannelsReceivers | Array of ChannelsReceivers | Recipient information of the channel |
| PolicyName | String | Alarm policy name |
| PromeInstanceID | String | Prometheus Instance ID, valid only when MT_PROME |
| PromeInstanceRegion | String | Region of the Prometheus Instance. Valid at that time only for MT_PROME. |
| Notices | Array of NotifyRelatedNotice | Notification template related configuration information |
| TriggerStatus | String | Alarm trigger status. Valid values: Trigger and Recovery. |
| PromeConsoleURL | String | Console page address related to the present Prometheus notification history, valid only when MR_PROME |
| Labels | Array of AlarmLable | Alarm label |
Product entity
Used by actions: DescribeAIWorkbenchArtifact, ListAIWorkbenchArtifacts.
| Name | Type | Description |
|---|---|---|
| ArtifactId | String | Product ID |
| Name | String | Product name |
| MimeType | String | Physical type |
| SizeBytes | Integer | File size (byte) |
| IsGlobal | Boolean | Whether it is public |
| CreatedAt | Integer | Creation time (Unix timestamp in seconds). |
| UpdatedAt | Integer | Modification time. |
| AgentId | String | Agent ID that generated the artifact |
| SkillId | String | Skill ID that generates the artifact |
| StoragePath | String | For parsing calls to the download API |
Receiver details
Used by actions: DescribeAlarmNotifyHistories.
| Name | Type | Required | Description |
|---|---|---|---|
| ChannelName | String | No | Notification channel name. Note: This field may return null, indicating that no valid values can be obtained. |
| Receivers | Array of String | No | Recipient. Note: This field may return null, indicating that no valid values can be obtained. |
| SendStatus | String | No | Sending result. Valid values: 0, (invalid), 1 (successful), 2 (failed), and 3 (no sending required). Note: This field may return null, indicating that no valid values can be obtained. |
Each ContentBlockInfo corresponds to an AGUI event converted from a downstream ContentBlock.
Used by actions: ListAIWorkbenchMessages.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Type. |
| Data | String | No | Data content. |
Environment variable entry
Used by actions: CreateAIWorkbenchAgent, DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent.
| Name | Type | Required | Description |
|---|---|---|---|
| Value | String | No | Environment variable value |
| Sensitive | Boolean | No | Whether to mask |
Environment variables required by the agent at runtime
Used by actions: CreateAIWorkbenchAgent, DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Environment variable key |
| Value | EnvEntry | No | Environment variable value |
Execution record entity
Used by actions: DescribeAIWorkbenchExecution, ListAIWorkbenchExecutions.
| Name | Type | Description |
|---|---|---|
| Name | String | Task name |
| TaskId | String | Task ID. |
| ExecutionId | String | Execution ID |
| AgentId | String | Agent ID |
| SessionId | String | Session ID |
| TriggerType | String | Trigger type: manual / cron / webhook |
| Status | String | Status: pending/running/completed/failed/timeout/cancelled |
| Summary | String | Execution Abstract |
| DurationMs | Integer | Execution time (ms) |
Clone prompt configuration
Used by actions: CreateAIWorkbenchAgent, UpdateAIWorkbenchAgent.
| Name | Type | Required | Description |
|---|---|---|---|
| RolePosition | String | No | Role definition |
| CoreDuty | String | No | Core responsibility |
| CoreTruths | String | No | Core principle |
| Vibe | String | No | Style constraints |
| Boundaries | String | No | Notes |
MCP entity
Used by actions: ListAIWorkbenchMCPs.
| Name | Type | Description |
|---|---|---|
| MCPId | String | mcp ID |
| Name | String | MCP name |
| Description | String | MCP description |
| Url | String | MCP URL |
| Transport | String | Transport protocol: sse / streamable_http / stdio |
| AuthType | String | Authentication type: none / bearer / basic / api_key |
| AuthSecret | String | Authentication key (masked in the response) |
| Timeout | Integer | Timeout (s) |
| RetryCount | Integer | Retry count |
| Headers | String | Request header JSON |
| Enabled | Boolean | Whether to enable |
Message entity
Used by actions: ListAIWorkbenchMessages.
| Name | Type | Description |
|---|---|---|
| EntryId | String | Entity id |
| SessionId | String | Conversation ID |
| Role | String | Role: user / assistant |
| Content | String | Message content |
| Status | String | Status. |
| ContentBlocks | Array of ContentBlockInfo | Block content. |
Notification template information associated with notification history
Used by actions: DescribeAlarmNotifyHistories.
| Name | Type | Description |
|---|---|---|
| NoticeId | String | Notification template ID |
| NoticeName | String | Name of the notification template |
Pagination request parameters
Used by actions: DescribeAlarmNotifyHistories.
| Name | Type | Required | Description |
|---|---|---|---|
| PerPage | Integer | No | Number of items per page. Note: This field may return null, indicating that no valid values can be obtained. |
| PageNo | String | No | Page number, starting from 1. Note: This field may return null, indicating that no valid values can be obtained. |
Pagination result parameters
Used by actions: DescribeAlarmNotifyHistories.
| Name | Type | Required | Description |
|---|---|---|---|
| TotalCount | Integer | No | Total data. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalPage | Integer | No | Total number of pages. Note: This field may return null, indicating that no valid values can be obtained. |
| CurrentPageNo | Integer | No | Current page number. Note: This field may return null, indicating that no valid values can be obtained. |
| End | Boolean | No | Whether it has traversed to the end. |
Input parameter for paginating by which page
Used by actions: ListAIWorkbenchResourceInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| PerPage | Integer | No | Number of items per page |
| PageNo | Integer | No | Page number, starting from 1 |
Pagination result parameters
Used by actions: ListAIWorkbenchAgents, ListAIWorkbenchArtifacts, ListAIWorkbenchExecutions, ListAIWorkbenchMCPs, ListAIWorkbenchResourceInstances, ListAIWorkbenchResourceMaps, ListAIWorkbenchSessions, ListAIWorkbenchSkills, ListAIWorkbenchTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| TotalCount | Integer | No | Total number of data |
| TotalPage | Integer | No | Total number of pages |
| CurrentPageNo | Integer | No | Current page number |
Resource instance
Used by actions: ListAIWorkbenchResourceInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | No | Instance ID |
| Service | String | No | Service name |
| Region | String | No | Region. |
| IsReady | Boolean | No | Ready? |
Resource map entity
Used by actions: ListAIWorkbenchResourceMaps.
| Name | Type | Description |
|---|---|---|
| ResourceMapId | String | Resource map ID |
| Name | String | Resource map name |
| Description | String | Resource map description |
| InstanceCount | Integer | Total number of instances |
Session entity
Used by actions: DescribeAIWorkbenchSession, ListAIWorkbenchSessions.
| Name | Type | Description |
|---|---|---|
| SessionId | String | Session ID |
| AgentId | String | Agent ID |
| Title | String | Session title |
| Status | String | Status: active / archived / deleted |
| TaskId | String | If the session is triggered by a task, carry the task ID that triggers the session. |
Skill entity
Used by actions: DescribeAIWorkbenchSkill, ListAIWorkbenchSkills.
| Name | Type | Description |
|---|---|---|
| SkillId | String | Skill ID |
| Name | String | Skill name |
| Description | String | Skill description. |
| Enabled | Boolean | Whether to enable |
Tag.
Used by actions: CreateAIWorkbenchAgent, DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Tag key |
| Value | String | Yes | Tag value |
Task entity
Used by actions: ListAIWorkbenchTasks.
| Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| Name | String | Task name |
| Description | String | Task description |
| AgentId | String | Associated Agent ID |
| PromptTemplate | String | Prompt Template |
| OutputFormat | String | Output format: markdown / json |
| TriggerType | String | Trigger type: manual / cron / webhook |
| CronExpr | String | Cron expression |
| CronTimezone | String | Cron time zone |
| SkillIds | Array of String | List of associated skill IDs. |
| McpEndpointIds | Array of String | Associated MCP endpoint ID list |
| TimeoutSec | Integer | Timeout (seconds) |
| RetryCount | Integer | Retry count |
| NotifyIds | Array of String | Notification id |
| Enabled | Boolean | Whether to enable |
文档反馈