All Products
Search

This Product

    EventBridge:GetAgentDataSemantics

    Document Center

    EventBridge:GetAgentDataSemantics

    Last Updated:Sep 02, 2026

    Retrieves the currently effective data semantics of an agent.

    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
    AgentName

    string

    Yes

    The name of the agent.

    bakehouse_agent

    Response elements

    Element

    Type

    Description

    Example

    object

    Message

    string

    The response message. An error message is returned if the request fails.

    Data semantics not found.
    RequestId

    string

    The unique request ID generated by Alibaba Cloud.

    5DAF96FB-A4DF-548C-B8A1-F2A8D2F4****
    Data

    object

    The details of the currently effective data semantics version. If generation is running, has failed, or has completed but has not been saved, only the official version is returned. No temporary snapshot is returned.

    VersionNo

    integer

    The currently effective version number.

    3
    Metrics

    array

    The SQL expression knowledge entries. A maximum of 100 entries are supported.

    AgentDataSemanticsMetric

    A single SQL expression knowledge entry.

    Joins

    array

    The data association knowledge entries. A maximum of 100 entries are supported.

    AgentDataSemanticsJoin

    A single data association knowledge entry.

    Examples

    array

    The SQL example knowledge entries. A maximum of 50 entries are supported.

    AgentDataSemanticsExample

    A single SQL example knowledge entry.

    Text

    AgentDataSemanticsText

    The text knowledge in Markdown format.

    Code

    string

    The response code.

    Success
    Success

    boolean

    Indicates whether the call was successful.

    true

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 InternalError Internal Server Error
    403 ServiceNotEnable Service not enable
    403 EventHouseServiceNotEnable EventHouse service not enable
    404 AgentNotFound Agent not found.
    404 DataSemanticsNotFound Data semantics not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.