Sessions
更新时间： 2026/11/04
在AtomGit上查看源码ResourceDefinition
uris
/redfish/v1/SessionService/Sessions/{session_id}
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | - | 指定会话资源模型的访问路径 |
| @odata.id | string | true | - | 指定会话资源节点的访问路径 |
| @odata.type | string | true | - | 指定会话资源类型 |
| Id | string | true | - | 指定会话资源的唯一标识 |
| Name | string | true | - | 指定会话的名称 |
| ClientOriginIPAddress | string | true | - | 新创建会话对应的用户的地址。openUBMC 25.12 LTS及以上版本支持 |
| CreatedTime | string | true | - | 新创建会话的创建时间。openUBMC 25.12 LTS及以上版本支持 |
| Roles[ ] | array | true | - | 用户角色。openUBMC 25.12 LTS及以上版本支持 |
| OemSessionType | string | true | - | OEM定义的会话类型。openUBMC 25.12 LTS及以上版本支持 |
| SessionType | string | true | ● WebUI ● ManagerConsole ● Redfish ● KVMIP ● OEM | 新创建会话对应的登录接口。openUBMC 25.12 LTS及以上版本支持，包括： ● KVMIP：KVM IP会话 ● ManagerConsole：管理控制台会话 ● Redfish：Redfish会话 ● WebUI：Web UI会话 |
| Oem { | object | true | - | 指定会话的自定义属性 |
| Oem.Public { | object | true | - | 指定会话的自定义属性 |
| Oem.Public.UserAccount | string | true | - | 该会话对应的用户 |
| Oem.Public.LoginTime | string | true | - | 该会话的创建时间。openUBMC 25.12 LTS及以上版本支持 |
| Oem.Public.UserIP | string | true | - | 该会话对应的用户的地址。openUBMC 25.12 LTS及以上版本支持 |
| Oem.Public.UserTag | string | true | ● GUI ● CLI ● Redfish ● VNC ● KVM | 该会话对应的登录接口。openUBMC 25.12 LTS及以上版本支持，包括： ● CLI：CLI ● GUI：GUI ● Redfish：Redfish ● VNC：VNC |
| Oem.Public.MySession | boolean | true | - | 表示查询的会话是否为当前用户所创建。true：是；false：否 |
| Oem.Public.UserId | number | true | - | 用户ID |
| Oem.Public.UserValidDays | number | true | - | 用户账号有效期 |
| Oem.Public.AccountInsecurePromptEnabled | boolean | true | - | 用户账号不安全提示使能 |
| Oem.Public.UserRole[ ] | array | true | - | 用户角色。openUBMC 25.12 LTS及以上版本支持 |
| } | ||||
| } | ||||
| UserName | string | true | - | 用户名称 说明 openUBMC 25.12 LTS及以上版本支持 |
supported_methods
- GET
- DELETE
HTTP methods
GET
命令功能
查询指定会话资源信息
命令格式
URL: https://device_ip/redfish/v1/SessionService/Sessions/session_id
请求头:
text
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| session_id | 指定会话的ID | 可通过会话集合资源获得 |
| auth_value | 执行该GET请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用指南
无
使用实例
请求样例：
http
GET <https://device_ip/redfish/v1/SessionService/Sessions/89abd1ef7686e27c>响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#Session.Session",
"@odata.id": "/redfish/v1/SessionService/Sessions/89abd1ef7686e27c",
"@odata.type": "#Session.v1_0_2.Session",
"Id": "89abd1ef7686e27c",
"Name": "User Session",
"ClientOriginIPAddress": "10.10.10.3",
"CreatedTime": "2016-09-09T19:48:28+00:00",
"Roles": ["Administrator"],
"SessionType": "Redfish",
"OemSessionType": "Redfish",
"Oem": {
"Public": {
"UserAccount": "root",
"LoginTime": "2016-09-09T19:48:28+00:00",
"UserIP": "10.10.10.3",
"UserTag": "Redfish",
"MySession": false,
"UserId": 4,
"UserValidDays": null,
"AccountInsecurePromptEnabled": false,
"UserRole": ["Administrator"]
}
}
}响应码：200
DELETE
命令功能
删除指定会话
命令格式
URL: https://device_ip/redfish/v1/SessionService/Sessions/session_id
请求头:
text
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| session_id | 待删除的会话ID | 在查询会话列表的返回信息中包含各会话的session_id，可用于删除指定会话信息 |
| auth_value | 请求消息的鉴权参数 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用指南
无
使用实例
请求样例：
http
DELETE <https://device_ip/redfish/v1/SessionService/Sessions/d0f0593601de6483>请求头：
text
X-Auth-Token: 123456789***********************请求消息体：无
响应样例：
json
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码：200
输出说明