ListThreads - STAROps - Alibaba Cloud Documentation Center

Lists sessions.

Operation description

Lists 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 employee.	test

Request parameters

Parameter	Type	Required	Description	Example
status	string	No	The session status.	active
threadId	string	No	The session 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	The filter conditions for the query. If this parameter is not specified, all topics under the instance are queried.
	object	No	The filter conditions for the query. If this parameter is not specified, all topics under the instance are queried.
key	string	Yes	The filter key. Valid values: title, workspace, and project.	title
value	string	Yes	The value to set.	test
includeMission	boolean	No	Specifies whether to include threads created by mission.

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	CD8BA7D6-995D-578D-9941-xxxx
threadId	string	The session ID.	thread-123123
total	integer	The total number of sessions.	1
maxResults	integer	The maximum number of results to return. Maximum value: 200.	20
threads	array<object>	The sessions.
	array<object>	The sessions.
threadId	string	The session ID.	thread-123123
digitalEmployeeName	string	The name of the digital employee.	test
title	string	The session title.	test
status	string	The session status.	active
version	integer	The version number.	123123
variables	object	The session properties.
workspace	string	The workspace.	workspace
project	string	SLS project。	project
createTime	string	The creation time in RFC 3339 format, including the time zone offset.	2025-12-19T15:19:55.040403272+08:00
updateTime	string	The update time in RFC 3339 format, including the time zone offset.	2025-12-19T15:19:55.040403272+08:00
attributes	object	The properties.
	string	The specific property.	test
nextToken	string	The pagination token.	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.