AssetAnswerSSE - Data Management - Alibaba Cloud Documentation Center

Queries asset information through the MetaAgent SSE interface.

Operation description

Returns asset query results in SSE streaming format. If DbId is specified, the query is performed within the specified database (asset_answer_agent). If DbId is not specified, the query is performed at the tenant level across all databases (tenant_answer_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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:AssetAnswerSSE

none

*All Resource

*

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DbId	string	No	The database ID. This parameter is optional. If specified, the query is performed within the specified database. If not specified, the query is performed at the tenant level across all databases. You can call the ListDatabases operation to obtain the database ID.	78459741
Query	string	Yes	The natural language question from the user.	Help me find the user table
Model	string	No	The name of the model to use. Only Qwen series models are supported.	qwen-max
QueryId	string	No	The request ID for the current query round. This value is used in the requestId field of SSE events.	test_001
SessionId	string	No	The session ID. This parameter is used for context association in multi-round conversations.	48363552-225c-4c93-aeab-ea9b9d064b96

Response elements

Element	Type	Description	Example
	object	The SSE streaming response. Each line is in the format data: {json}\n\n. During normal streaming, the response contains requestId/output. If RAM authentication fails, the response contains a standard POP error body (including AccessDeniedDetail).
AccessDeniedDetail	object	The details of the RAM authentication failure.
AuthAction	string	The operation name.	xx
AuthPrincipalDisplayName	string	The identity used for authentication in the request.	xx
AuthPrincipalOwnerId	string	The ID of the authorization principal owner.	xx
AuthPrincipalType	string	The type of the authorization principal.	xx
EncodedDiagnosticMessage	string	The encrypted complete diagnostic message.	AQEAAAAAaJQJ5zhGNzBCNzFGLUJEODctNTAzQi1CNTUxLUMwODI2NzhFRDRERA==
NoPermissionType	string	The reason for the authentication failure.	xx
PolicyType	string	The policy type.	System
Code	string	The error code.	200
Data	any	The paginated result of table assets.	1001
ErrorCode	string	The error code.	200
ErrorMessage	string	The error message.	UnknownError
HostId	string	The host ID.	100.127.196.34
Message	string	The error message.	UnknownError
Recommend	string	Indicates whether the service is set as a recommended service and published to the service catalog.	true
RequestId	string	The request ID.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
Success	boolean	true: Disabled successfully. false: Failed to disable.	true
TraceId	string	The trace ID for tracking service requests.	0a06e1e316757357507896067d3780

Examples

Success response

JSON format

{
  "AccessDeniedDetail": {
    "AuthAction": "xx",
    "AuthPrincipalDisplayName": "xx",
    "AuthPrincipalOwnerId": "xx",
    "AuthPrincipalType": "xx",
    "EncodedDiagnosticMessage": "AQEAAAAAaJQJ5zhGNzBCNzFGLUJEODctNTAzQi1CNTUxLUMwODI2NzhFRDRERA==",
    "NoPermissionType": "xx",
    "PolicyType": "System"
  },
  "Code": "200",
  "Data": "1001",
  "ErrorCode": "200",
  "ErrorMessage": "UnknownError",
  "HostId": "100.127.196.34",
  "Message": "UnknownError",
  "Recommend": "true",
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "Success": true,
  "TraceId": "0a06e1e316757357507896067d3780"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.