文档中心
RoleCollection
更新时间： 2026/06/26
在Gitcode上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/AccountService/Roles

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-角色列表资源模型的OData描述信息
@odata.idstringtrue-角色列表资源节点的访问路径
@odata.typestringtrue-角色列表资源类型
Namestringtrue-角色列表资源的名称
Membersobjecttrue-角色列表，服务器当前支持的角色类型包括：Administrator、Operator、Commonuser、NoAccess、CustomRole1~CustomRole16
Members@odata.countnumbertrue-服务器当前存在的角色类型的个数

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询角色集合资源信息

命令格式

URL: https://device_ip/redfish/v1/AccountService/Roles

请求头:


X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
auth_value执行该GET请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http
GET https://device_ip/redfish/v1/AccountService/Roles

请求头：


X-Auth-Token: 123456789***********************

请求消息体：无

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",
  "@odata.id": "/redfish/v1/AccountService/Roles",
  "@odata.type": "#RoleCollection.RoleCollection",
  "Name": "Roles Collection",
  "Members@odata.count": 8,
  "Members": [
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/Operator"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/Commonuser"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/NoAccess"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole2"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole3"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole4"
    }
  ]
}

响应码：200

POST (CREATE) ​

命令功能

创建自定义角色

命令格式

URL：https://device_ip/redfish/v1/AccountService/Roles

请求头：


X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体：

json
{
  "RoleId": role_id,
  "Id": id,
  "AssignedPrivileges": [
    Privilegelist1
  ],
  "OemPrivileges": [
    Privilegelist2
  ]
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
role_id角色ID可新增的自定义角色包括：CustomRole5~CustomRole16，必选参数
id角色ID可新增的自定义角色包括：CustomRole5~CustomRole16，需与role_id一致
Privilegelist1Redfish定义的权限● "Login"
● "ConfigureComponents"
● "ConfigureSelf"
可同时配置多种权限，并以","分割。其中，"Login","ConfigureSelf"为必配参数
Privilegelist2服务器定义的权限● "OemKvm"
● "OemVmm"
● "OemSecurityMgmt"
● "OemPowerControl"
● "OemDiagnosis"
可以为空，也可同时配置多种权限，并以","分割

使用指南

无

使用实例

请求样例：

http
POST https://device_ip/redfish/v1/AccountService/Roles

请求头：

X-Auth-Token: 123456789*********************** Content-Type: application/json If-Match：W/"3d607e36"

请求消息体：

json
{
  "RoleId": "CustomRole5",
  "AssignedPrivileges": [
    "Login",
    "ConfigureSelf"
  ],
  "OemPrivileges": [
    "OemKvm",
    "OemVmm"
  ]
}

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",
  "@odata.id": "/redfish/v1/AccountService/Roles",
  "@odata.type": "#RoleCollection.RoleCollection",
  "Name": "Roles Collection",
  "Members@odata.count": 8,
  "Members": [
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/Operator"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/Commonuser"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/NoAccess"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole2"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole3"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole4"
    },
    {
      "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole5"
    }
  ]
}

响应码：200