GetMessages

更新时间:
复制 MD 格式

Retrieves a list of messages in a specific conversation.

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

rdsai:GetMessages

none

*All Resource

*

None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ConversationId

string

No

The ID of the conversation.

941c6f59-acf5-4e11-9adc-31e52e1f****

FirstId

string

No

The ID of the message from which to start fetching the list. Use this for pagination.

038866af-a050-4bc5-bfad-b7bfc838****

Limit

integer

No

The maximum number of messages to return per page. Valid values: 1–100. Default: 100.

10

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The unique identifier for the request.

FE9C65D7-930F-57A5-A207-8C396329****

Data

array<object>

A list of message objects.

array<object>

The details of a message.

Id

string

The unique identifier for the message.

84dc9f9b-424a-404d-9c36-35e9d000****

ConversationId

string

The unique identifier for the conversation.

9cbbe885-b240-4803-9d15-6781a3fd****

Query

string

The user's query.

实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容

Answer

string

The AI-generated response to the query.

您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!

CreatedAt

string

The Unix timestamp (in seconds) when the message was created.

1763986004

Feedback

string

The user's feedback on the answer, such as "like" or "dislike".

like

RetrieverResources

array

The resources that were retrieved to generate the answer.

any

A retrieved resource.

测试字段,不用关注。

Events

array<object>

object

event

string

answer

string

HasMore

boolean

Indicates whether there are more messages to retrieve.

true

Limit

integer

The value of the Limit parameter used for this request.

100

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Data": [
    {
      "Id": "84dc9f9b-424a-404d-9c36-35e9d000****",
      "ConversationId": "9cbbe885-b240-4803-9d15-6781a3fd****",
      "Query": "实例rm-bp14as9914vd3**** 磁盘使用率,是否需要扩容",
      "Answer": "您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%,暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作,请告诉我具体需求!",
      "CreatedAt": "1763986004",
      "Feedback": "like",
      "RetrieverResources": [
        "测试字段,不用关注。"
      ],
      "Events": [
        {
          "event": "",
          "answer": ""
        }
      ]
    }
  ],
  "HasMore": true,
  "Limit": 100
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The provided parameter is invalid. Invalid parameter.
404 UserNotFound User does not exist. User does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.