All Products
Search
Document Center

:DescribePolarAgentUserSessions

Last Updated:Jan 22, 2026

Queries historical session records.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

Source

string

No

The source of the product. The value is `polardb-console`.

polardb-console

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

E2FDB684-751D-424D-98B9-704BEA******

Data

array<object>

The result set.

object

The result set.

SessionId

string

The session ID.

01IC17MLISBB98SL345H7B5AES1E8VB1

Title

string

The content.

content

SessionStatus

integer

The status of the session. Valid values:

  • 1: Active

  • 0: Closed

1

Examples

Success response

JSON format

{
  "RequestId": "E2FDB684-751D-424D-98B9-704BEA******\t\n",
  "Data": [
    {
      "SessionId": "01IC17MLISBB98SL345H7B5AES1E8VB1",
      "Title": "content",
      "SessionStatus": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.