SchemaStore
更新时间: 2026/06/26
在Gitcode上查看源码ResourceDefinition
uris
/redfish/v1/SchemaStore/{language_id}/{file_id}
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| $schema | string | true | - | JSON Schema文档路径 |
| title | string | true | - | Schema标题 |
| $ref | string | true | - | 定义引用路径 |
| definitions | object | true | - | Schema定义内容 |
supported_methods
- GET
HTTP methods
GET
命令功能
查询单个 Schema 文件资源
命令格式
URL: https://device_ip/redfish/v1/SchemaStore/language_id/file_id
请求头:
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| auth_value | 执行该GET请求时,必须在"Headers"中携带"X-Auth-Token"值用于鉴权 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
| language_id | 模式所在文件的语言代码 | 当前的取值为"en" |
| file_id | Schemas文件名 | 需要查询的Schema文件名 |
使用指南
无
使用实例
请求样例:
http
GET https://device_ip/redfish/v1/SchemaStore/en/Volume.v1_0_0.json请求头:
X-Auth-Token: 123456789***********************请求消息体:无
响应样例:
json
{
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_1_0.json",
"title": "#HwVncService.HwVncService",
"$ref": "#/definitions/HwVncService",
"definitions": {
"HwVncService": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/idRef"
},
{
"$ref": "/redfish/v1/SchemaStore/en/HwVncService.v1_0_0.json#/definitions/HwVncService"
}
]
}
},
"copyright": "Copyright © Xuzhe Technologies Co., Ltd. 2004-2005. All rights reserved."
}
{
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_1_0.json",
"title": "#Volume.v1_0_0.Volume",
"$ref": "#/definitions/Volume",
"definitions": {
"Initialize": {
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Friendly action name"
},
"target": {
"type": "string",
"format": "uri",
"description": "Link to invoke action"
}
},
"description": "This action is used to prepare the contents of the volume for use by the system.",
"longDescription": "This defines the name of the custom action supported on this resource."
},
"EncryptionTypes": {
"type": "string",
"enum": [
"NativeDriveEncryption",
"ControllerAssisted",
"SoftwareAssisted"
],
"enumDescriptions": {
"NativeDriveEncryption": "The volume is utilizing the native drive encryption capabilities of the drive hardware",
"ControllerAssisted": "The volume is being encrypted by the storage controller entity",
"SoftwareAssisted": "The volume is being encrypted by software running on the system or the operating system"
}
},
"Volume": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": false,
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/context"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/type"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name"
}
},
"required": [
"Id",
"Name"
],
"description": "Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.",
"longDescription": "This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation."
},
"VolumeType": {
"type": "string",
"enum": [
"RawDevice",
"NonRedundant",
"Mirrored",
"StripedWithParity",
"SpannedMirrors",
"SpannedStripesWithParity"
]
}
},
"copyright": "Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright"
}响应码:200