Updated on 2022-12-12 GMT+08:00

Querying Bastion Host Historical Sessions

Function

Query historical sessions of a bastion host.

URI

GET /v2/servicerequest/authorizations/{authorization_id}/authorization-details/{authorization_detail_id}/history-sessions

Table 1 Path parameters

Parameter

Mandatory

Type

Description

authorization_id

Yes

String

Specifies the authorization ID.

Minimum length: 1

Maximum length: 32

authorization_detail_id

Yes

Long

Specifies the authorization detail ID.

Minimum value: 0

Maximum value: 9223372036854775807

Table 2 Query parameters

Parameter

Mandatory

Type

Description

group_id

No

String

Specifies the group ID.

Minimum length: 0

Maximum length: 64

offset

No

Integer

Specifies the query offset.

Minimum value: 0

Maximum value: 65535

Default value: 0

limit

No

Integer

Specifies the limited number of records that can be queried.

Minimum value: 1

Maximum value: 100

Default value: 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Indicates the total number of records.

Minimum value: 0

Maximum value: 9223372036854775807

session_list

Array of OperateHistorySession objects

Indicates the session list.

Table 5 OperateHistorySession

Parameter

Type

Description

duration

String

Indicates the session time, in hh:ii:ss format.

Minimum length: 0

Maximum length: 64

session_id

Long

Specifies the session ID.

Minimum value: 0

Maximum value: 9223372036854775807

start_time

String

Indicates the session start time.

Minimum length: 0

Maximum length: 64

end_time

String

Indicates the session end time.

Minimum length: 0

Maximum length: 64

Request Example

None

Example Response

Status code: 200

Response of status code 200

{
  "total_count" : 1,
  "session_list" : [ {
    "duration" : "test",
    "session_id" : 1,
    "start_time" : "test",
    "end_time" : "test"
  } ]
}

Status Codes

Status Code

Description

200

Response of status code 200

Error Codes

See Error Codes.