All Products
Search
Document Center

:DescribePolarAgentSessionStatus

Last Updated:Jan 22, 2026

Queries the status of a session.

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

SessionId

string

Yes

The ID of the session. This ID is used to identify a visitor's session and maintain context information.

1e28530a0da2c4755f165b1b8b9a73c9

Source

string

No

The source of the product. Set the value to polardb-console.

polardb-console

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The ID of the request.

CDB3258F-B5DE-43C4-8935-CBA0CA******

Status

integer

The status of the session. Valid values:

  • 1: Enabled

  • 0: Disabled

1

Examples

Success response

JSON format

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "Status": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.