Help Center/ Workspace/ API Reference/ Workspace APIs/ Agent Instance Management/ Querying the Statistics of Agent Instances
Updated on 2026-07-24 GMT+08:00
View PDF
Share

Querying the Statistics of Agent Instances

Function

Queries the statistics of agent instances, including the total number of desktops, number of desktops without models configured, number of desktops without channels configured, and number of risky desktops.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:agentInstance:list

    List

    -

    -

    -

    -

URI

GET /v3/ai-agents/instances/statistics

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

ai_agent_type

No

String

Agent type.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total_count

Long

Total number of desktops.

unconfigured_model_count

Long

Number of desktops without models configured.

unconfigured_channel_count

Long

Number of desktops without channels configured.

risk_count

Long

Number of risky desktops.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Operation successful.

{
  "total_count" : 100,
  "unconfigured_model_count" : 20,
  "unconfigured_channel_count" : 15,
  "risk_count" : 5
}

Status Codes

Status Code

Description

200

Operation successful.

400

Invalid request parameters.

401

Authorization failed.

403

No permissions.

500

Internal server error.

Error Codes

See Error Codes.