ListArtifacts - STAROps - Alibaba Cloud Documentation Center

Operation description

Lists artifacts for a specified digital employee.

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:ListArtifacts

list

*DigitalEmployee

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

None

Request syntax

GET /digitalEmployee/{name}/artifacts 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
artifactPath	string	Yes	The path from which to list artifacts. If you specify a directory path, this operation lists all files and subdirectories within it. If you omit this parameter, the operation lists artifacts from the root directory.	missions/mission-xxx/artifacts/2026-05/05-01/
maxResults	integer	No	The maximum number of artifacts to return per page. If omitted, a default value is used.	10
nextToken	string	No	The pagination token used to retrieve the next page of results. This value is obtained from the response of a previous request.	xxx

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The ID of the request.	8FDE2569-626B-5176-9844-28877A*****
artifacts	array<object>	A list of artifacts.	[{"path":"reports/summary.pdf","size":1024,"lastModified":"2026-05-25T08:00:00Z","isDirectory":false}]
	object	An object representing a single artifact.
path	string	The relative path of the artifact.	missions/mission-xxx/artifacts/2026-05/05-01/xxxx.md
size	integer	The size of the artifact in bytes.	21950
lastModified	string	The last modification time of the artifact, in ISO 8601 format.	2026-04-30T16:03:54Z
isDirectory	boolean	Indicates whether the path points to a directory. A value of `true` indicates a directory, and a value of `false` indicates a file.	false
nextToken	string	The token for retrieving the next page of results. This field is empty when there are no more results.	xxx
maxResults	integer	The maximum number of entries returned on each page.	10

Examples

Success response

JSON format

{
  "requestId": "8FDE2569-626B-5176-9844-28877A*****\n",
  "artifacts": [
    {
      "path": "missions/mission-xxx/artifacts/2026-05/05-01/xxxx.md",
      "size": 21950,
      "lastModified": "2026-04-30T16:03:54Z",
      "isDirectory": false
    }
  ],
  "nextToken": "xxx",
  "maxResults": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.