ListThreads - STAROps - Alibaba Cloud Documentation Center

List sessions

Operation description

List sessions

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

starops:ListThreads

get

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/{#name}/thread/*

None

Request syntax

GET /digitalEmployee/{name}/threads HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the digital worker.	test

Request parameters

Parameter	Type	Required	Description	Example
status	string	No	The status of the thread.	active
threadId	string	No	The thread ID.	thread-123123
maxResults	integer	No	The maximum number of results to return. Maximum value: 200.	20
nextToken	string	No	The pagination token.	xxxxxx
filter	array<object>	No	Filters the results. If this parameter is omitted, the operation returns all threads in the instance.
	object	No	A filter object.
key	string	Yes	The filter key. Supported values are title, workspace, and project.	title
value	string	Yes	The value for the filter key.	test
includeMission	boolean	No	Specifies whether to include threads created by missions.

Response elements

Element	Type	Description	Example
	object	The response data.
requestId	string	The request ID.	CD8BA7D6-995D-578D-9941-xxxx
threadId	string	The thread ID.	thread-123123
total	integer	The total number of threads.	1
maxResults	integer	The maximum number of results to return. The maximum value is 200.	20
threads	array<object>	A list of threads.
	array<object>	A thread object.
threadId	string	The thread ID.	thread-123123
digitalEmployeeName	string	The digital employee name.	test
title	string	The thread title.	test
status	string	The thread status.	active
version	integer	The thread version.	123123
variables	object	The thread variables.
workspace	string	The workspace.	workspace
project	string	The project in SLS.	project
createTime	string	The creation time of the thread, in ISO 8601 format.	2025-12-19T15:19:55.040403272+08:00
updateTime	string	The last update time of the thread, in ISO 8601 format.	2025-12-19T15:19:55.040403272+08:00
attributes	object	A map of key-value pairs that you can attach to the thread.
	string	The attribute value.	test
nextToken	string	A token to retrieve the next page of results. If this parameter is absent, no more results are available.	xxxxxxxxxx

Examples

Success response

JSON format

{
  "requestId": "CD8BA7D6-995D-578D-9941-xxxx\n",
  "threadId": "thread-123123\n",
  "total": 1,
  "maxResults": 20,
  "threads": [
    {
      "threadId": "thread-123123\n",
      "digitalEmployeeName": "test",
      "title": "test",
      "status": "active",
      "version": 123123,
      "variables": {
        "workspace": "workspace",
        "project": "project"
      },
      "createTime": "2025-12-19T15:19:55.040403272+08:00\n",
      "updateTime": "2025-12-19T15:19:55.040403272+08:00\n",
      "attributes": {
        "key": "test"
      }
    }
  ],
  "nextToken": "xxxxxxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.