AGBCLOUD

Appearance

List Sessions ​

Query and filter active sessions in your account.

What you'll do ​

List active sessions with optional pagination and label-based filtering.

Prerequisites ​

  • AGB_API_KEY

Quickstart ​

python
from agb import AGB

agb = AGB()
result = agb.list()

if result.success:
    print("Total sessions:", result.total_count)
    for session_id in result.session_ids:
        print("Session ID:", session_id)
typescript
import { AGB } from "agbcloud-sdk";

const agb = new AGB();
const result = await agb.list();

if (result.success) {
  console.log("Total sessions:", result.totalCount);
  for (const sessionId of result.sessionIds ?? []) {
    console.log("Session ID:", sessionId);
  }
}

Common tasks ​

Paginate results ​

python
result = agb.list(page=2, limit=10)
if result.success:
    print("Total:", result.total_count)
    print("Next token:", result.next_token)
typescript
const result = await agb.list();
if (result.success) {
  console.log("Total:", result.totalCount);
  console.log("Next token:", result.nextToken);
}

Filter by labels ​

python
result = agb.list(labels={"project": "demo", "environment": "testing"})
if result.success:
    for session_id in result.session_ids:
        print("Session ID:", session_id)
typescript
const result = await agb.list({ project: "demo", environment: "testing" });
if (result.success) {
  for (const sessionId of result.sessionIds ?? []) {
    console.log("Session ID:", sessionId);
  }
}

Response fields ​

FieldDescription
session_ids / sessionIdsList of active session IDs
total_count / totalCountTotal number of sessions matching the query
next_token / nextTokenToken for fetching the next page

Best practices ​

  • Use labels consistently when creating sessions to enable effective filtering
  • list() returns only active sessions; released sessions will not appear