DescribeCreditPackageAgents - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries a list of agents and their usage information.

Operation description

Usage notes

Pagination: This operation supports pagination by using the NextToken and MaxResults parameters. For the first request, set NextToken to an empty string.
Filtering: Use the AgentType and AgentIds parameters to filter the results.
Status filtering: Use the Status parameter to filter agents by status. Valid values are 0 (deleted) and 1 (active).
Sorting: By default, the results are sorted by id in ascending order.
Additional parameter for anonymous edition: The FillInstance parameter automatically populates the ID of the JVS_COPILOT agent that is associated with the current user.

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

ecd:DescribeCreditPackageAgents

list

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
BizType	string	No	The business type.	BUSINESS
AgentType	string	No	The agent type. Valid values: `CREDIT_PACKAGE`, `JVS_CLAW`, `OPEN_CLAW`, and `JVS_COPILOT`.	JVS_COPILOT
AgentIds	array	No	An array of agent IDs to query. Example: `["agent-1","agent-2"]`.
	string	No	An agent ID.	jvs-xxxx
MaxResults	integer	No	The maximum number of results to return per page.	100
NextToken	string	No	The token to retrieve the next page of results. Obtain this value from the `NextToken` parameter of the previous response. For the first request, set this parameter to an empty string.	eyJvZmZzZXQiOjIwfQ==

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Provide this ID when contacting support.	xxxx-xxxx-xxxx
Agents	array<object>	A list of agents.
	object
AgentId	string	The ID of the agent.	agent-abc
InstanceType	string	The instance type.	jvs-copilot.standard
CreatedTime	string	The creation time of the instance.	2026-04-01 10:00:00
ExpiredTime	string	The expiration time of the instance.	2026-10-01 10:00:00
UsedCredit	integer	The amount of credit used.	100
TotalCredit	integer	The total credit.	2000
CreditPackageId	string	The ID of the active credit package instance.	cp-inst-001
WarnPercent	integer	The alarm threshold, specified as a percentage. Valid values: 0 to 100.	80
MaxResults	integer	The number of results returned on the current page.	20
NextToken	string	The token to retrieve the next page of results. If this value is empty, all results have been returned.	eyJvZmZzZXQiOjIwfQ==

Examples

Success response

JSON format

{
  "RequestId": "xxxx-xxxx-xxxx",
  "Agents": [
    {
      "AgentId": "agent-abc",
      "InstanceType": "jvs-copilot.standard",
      "CreatedTime": "2026-04-01 10:00:00",
      "ExpiredTime": "2026-10-01 10:00:00",
      "UsedCredit": 100,
      "TotalCredit": 2000,
      "CreditPackageId": "cp-inst-001",
      "WarnPercent": 80
    }
  ],
  "MaxResults": 20,
  "NextToken": "eyJvZmZzZXQiOjIwfQ=="
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.