UploadAgentConversationLog - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

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

rocketmq:UploadAgentConversationLog

none

*All Resource

*

None

Request syntax

POST /api/v1/conversations/{conversationId}/logs HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
conversationId	string	Yes	The ID of the existing conversation. You must have write permissions for the conversation.	0198c8a91f4d7f01a3c21e97

Request parameters

Parameter	Type	Required	Description	Example
body	object	Yes	The log upload request.
fileName	string	Yes	The name of the client log file. Only log, txt, out, and rolling log files are supported. ZIP files must be decompressed and trimmed on the client side.	client.log
contentGzipB64	string	Yes	The Base64-encoded content of the UTF-8 log compressed by using gzip. The decompressed content can be up to 200 MiB in size, and the Base64-encoded string can be up to 5 MiB in size.	H4sIAAAAAAAAEzMyMDLTNbDUNTQKMTSwMgAhbQMLKwMDBU8/N3+F4sq8kozUksxkheSczNS8EoWc/HSF4pLEohIuIwydhgR1pualcAEAN/JXaXIAAAA=
timeRangeStart	string	No	The start time for log trimming in ISO 8601 format with a time zone.	2026-09-12T10:00:00+08:00
timeRangeEnd	string	No	The end time for log trimming in ISO 8601 format with a time zone.	2026-09-12T11:00:00+08:00

Response elements

Element	Type	Description	Example
	object
id	string	The ID of the uploaded log object.	0198c8a91f4d7f01a3c21e99
fileName	string	The name of the saved log file.	client.log
size	integer	The size of the decompressed log in bytes.	114
sandboxPath	string	The relative reference of the log in the current session. Include this value as-is in message attachments. Do not construct it manually.	client-logs/0198c8a91f4d7f01a3c21e99/client.log

Examples

Success response

JSON format

{
  "id": "0198c8a91f4d7f01a3c21e99",
  "fileName": "client.log",
  "size": 114,
  "sandboxPath": "client-logs/0198c8a91f4d7f01a3c21e99/client.log"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.