Queries the session records of Elastic Compute Service (ECS) Session Manager.
Operation description
You can query the session records of Session Manager that were generated in the last four weeks.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. | cn-hangzhou |
InstanceId | string | No | The instance ID. | i-bp1i7gg30r52z2em**** |
SessionId | string | No | The session ID. | s-hz023od0x9**** |
MaxResults | integer | No | The maximum number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | AAAAAdDWBF2**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"NextToken": "AAAAAdDWBF2****",
"Sessions": {
"Session": [
{
"CreationTime": "2024-01-19T09:15:46Z",
"TargetServer": "192.168.0.246",
"PortNumber": 22,
"PrincipalId": "123456xxxx",
"Username": "root",
"ClientIP": "192.168.1.1",
"IdentityType": "RAMUser",
"SessionId": "s-hz023od0x9****",
"Connections": {
"Connection": [
{
"ClosedReason": "AgentNeedUpgrade",
"EndTime": "2024-01-19T09:16:46Z",
"Status": "Connecting",
"StartTime": "2024-01-19T09:16:40Z",
"InstanceId": "i-bp1i7gg30r52z2em****"
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | The specified parameter NextToken is illegal. |
400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | The specified parameter MaxResults is illegal. |
404 | InvalidRegionId.NotFound | The specified parameter RegionId does not exist. | - |
500 | InternalError | An error occurred when you dispatched the request. | An error occurred while sending the request, please try again later. |
For a list of error codes, visit the Service error codes.