代码仓
中
HttpsCert
更新时间: 2026/11/04
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/SecurityService/HttpsCert

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-SSL证书资源模型的OData描述信息
@odata.idstringtrue-SSL证书资源节点的访问路径
@odata.typestringtrue-SSL证书资源类型
Idstringtrue-SSL证书资源的ID
Namestringtrue-SSL证书资源的名称
X509CertificateInformation {objecttrue-X.509证书信息
X509CertificateInformation.ServerCert {objecttrue-SSL证书链中的末端生效证书信息,为此CA证书的主要信息,展示内容和外层信息一致
X509CertificateInformation.ServerCert.Issuerstringtrue-中间证书签发者
X509CertificateInformation.ServerCert.KeyUsagestringtrue-中间证书密钥用法
X509CertificateInformation.ServerCert.PublicKeyLengthBitsnumbertrue-中间证书公钥长度
X509CertificateInformation.ServerCert.SerialNumberstringtrue-中间证书序列号
X509CertificateInformation.ServerCert.SignatureAlgorithmstringtrue-中间证书签名算法
X509CertificateInformation.ServerCert.Subjectstringtrue-中间证书使用者
X509CertificateInformation.ServerCert.ValidNotAfterstringtrue-中间证书生效结束日期
X509CertificateInformation.ServerCert.ValidNotBeforestringtrue-中间证书生效起始日期
X509CertificateInformation.ServerCert.IsDefaultSSLCertbooleantrue-标志当前服务器证书是否是初始证书
说明
openUBMC 25.12 LTS及以上版本支持,布尔类型
}
X509CertificateInformation.IntermediateCert [ {arraytrue-中间证书列表
X509CertificateInformation.IntermediateCert[].Subjectstringtrue-中间证书使用者
X509CertificateInformation.IntermediateCert[].Issuerstringtrue-中间证书签发者
X509CertificateInformation.IntermediateCert[].ValidNotBeforestringtrue-中间证书生效起始日期
X509CertificateInformation.IntermediateCert[].ValidNotAfterstringtrue-中间证书生效结束日期
X509CertificateInformation.IntermediateCert[].SerialNumberstringtrue-中间证书序列号
X509CertificateInformation.IntermediateCert[].SignatureAlgorithmstringtrue-中间证书签名算法
X509CertificateInformation.IntermediateCert[].KeyUsagestringtrue-中间证书密钥用法
X509CertificateInformation.IntermediateCert[].PublicKeyLengthBitsnumbertrue-中间证书公钥长度
} ]
X509CertificateInformation.RootCert {objecttrue-根证书
X509CertificateInformation.RootCert.Subjectstringtrue-根证书使用者
X509CertificateInformation.RootCert.Issuerstringtrue-根证书签发者
X509CertificateInformation.RootCert.ValidNotBeforestringtrue-根证书生效起始日期
X509CertificateInformation.RootCert.ValidNotAfterstringtrue-根证书生效结束日期
X509CertificateInformation.RootCert.SerialNumberstringtrue-根证书序列号
X509CertificateInformation.RootCert.SignatureAlgorithmstringtrue-根证书签名算法
X509CertificateInformation.RootCert.KeyUsagestringtrue-根证书密钥用法
X509CertificateInformation.RootCert.PublicKeyLengthBitsnumbertrue-根证书公钥长度
}
}
AlternativeInitialCertificate {objecttrue-备用初始证书信息
AlternativeInitialCertificate.ServerCert {objecttrue-SSL证书链中的末端生效证书信息,为此CA证书的主要信息,展示内容和外层信息一致
AlternativeInitialCertificate.ServerCert.Issuerstringtrue-中间证书签发者
AlternativeInitialCertificate.ServerCert.KeyUsagestringtrue-中间证书密钥用法
AlternativeInitialCertificate.ServerCert.PublicKeyLengthBitsnumbertrue-中间证书公钥长度
AlternativeInitialCertificate.ServerCert.SerialNumberstringtrue-中间证书序列号
AlternativeInitialCertificate.ServerCert.SignatureAlgorithmstringtrue-中间证书签名算法
AlternativeInitialCertificate.ServerCert.Subjectstringtrue-中间证书使用者
AlternativeInitialCertificate.ServerCert.ValidNotAfterstringtrue-中间证书生效结束日期
AlternativeInitialCertificate.ServerCert.ValidNotBeforestringtrue-中间证书生效起始日期
}
}
CertificateSigningRequeststringtrue-CSR信息说明导入服务器证书后,之前生成的CSR信息清除,此处显示为“null”。
Actions {objecttrue-SSL证书组密钥导入操作
Actions.#HttpsCert.GenerateCSR {objecttrue-生成CSR文件的资源路径
Actions.#HttpsCert.GenerateCSR.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#HttpsCert.GenerateCSR.targetstringtrue-操作路径
}
Actions.#HttpsCert.ImportServerCertificate {objecttrue-导入服务器证书的资源路径
Actions.#HttpsCert.ImportServerCertificate.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#HttpsCert.ImportServerCertificate.targetstringtrue-操作路径
}
Actions.#HttpsCert.ImportCustomCertificate {objecttrue-导入自定义证书的资源路径
Actions.#HttpsCert.ImportCustomCertificate.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#HttpsCert.ImportCustomCertificate.targetstringtrue-操作路径
}
Actions.#HttpsCert.ExportCSR {objecttrue-导出CSR文件
Actions.#HttpsCert.ExportCSR.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#HttpsCert.ExportCSR.targetstringtrue-操作路径
}
}

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询 SSL 证书资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert

请求头:

text
X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例: GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert

X-Auth-Token: auth_value 请求消息体:无

响应样例:

json
{
"@odata.context": "/redfish/v1/$metadata#HttpsCert.HttpsCert",
"@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert",
"@odata.type": "#HttpsCert.v1_0_0.HttpsCert",
"Id": "HttpsCert",
"Name": "Https cert info",
"X509CertificateInformation": {
"ServerCert": {
"Subject": "CN=Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"Issuer": "CN=Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"ValidNotBefore": "Jul 25 2014 GMT",
"ValidNotAfter": "Jul 22 2024 GMT",
"SerialNumber": "07 ",
"SignatureAlgorithm": "sha256WithRSAEncryption",
"KeyUsage": "Certificate Signing, CRL Sign",
"PublicKeyLengthBits": 2048,
"IsDefaultSSLCert": true
},
"IntermediateCert": [
{
"Subject": "CN=Intermediate, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"Issuer": "CN=Root, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"ValidNotBefore": "Jan 01 2020 GMT",
"ValidNotAfter": "Jan 01 2030 GMT",
"SerialNumber": "01 ",
"SignatureAlgorithm": "sha256WithRSAEncryption",
"KeyUsage": "Certificate Signing, CRL Sign",
"PublicKeyLengthBits": 2048
}
],
"RootCert": {
"Subject": "CN=Root, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"Issuer": "CN=Root, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"ValidNotBefore": "Jan 01 2010 GMT",
"ValidNotAfter": "Jan 01 2040 GMT",
"SerialNumber": "00 ",
"SignatureAlgorithm": "sha256WithRSAEncryption",
"KeyUsage": "Certificate Signing, CRL Sign",
"PublicKeyLengthBits": 2048
}
},
"AlternativeInitialCertificate": {
"ServerCert": {
"Subject": "CN=Alternative Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"Issuer": "CN=Alternative Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
"ValidNotBefore": "Jul 25 2024 GMT",
"ValidNotAfter": "Jul 22 2034 GMT",
"SerialNumber": "08 ",
"SignatureAlgorithm": "sha256WithRSAEncryption",
"KeyUsage": "Certificate Signing, CRL Sign",
"PublicKeyLengthBits": 2048
}
},
"CertificateSigningRequest": null,
"Actions": {
"#HttpsCert.GenerateCSR": {
"target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR",
"@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/GenerateCSRActionInfo"
},
"#HttpsCert.ImportServerCertificate": {
"target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate",
"@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/ImportServerCertificateActionInfo"
},
"#HttpsCert.ImportCustomCertificate": {
"target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate",
"@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/ImportCustomCertificateActionInfo"
},
"#HttpsCert.ExportCSR": {
"target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR",
"@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/ExportCSRActionInfo"
}
}
}

响应码:200

POST (ACTION) ​

GenerateCSR ​

命令功能

生成 CSR

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR

请求头:

text
X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
"Country": country,
"CommonName": commonname,
"City": city,
"State": state,
"OrgName": orgname,
"OrgUnit": orgunit
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
country使用者所在的国家,为必配参数。支持字母,长度为2个字符。
commonname使用者的名称为必配参数。支持字母、数字、连字符、下划线、句点和空格,最大长度64个字符。
city使用者所在的城市,非必配参数。支持字母、数字、连字符、下划线、句点和空格,最大长度128个字符。
state使用者所在的省份,非必配参数。支持字母、数字、连字符、下划线、句点和空格,最大长度128个字符。
orgname使用者所在的公司,非必配参数。支持字母、数字、连字符、下划线、句点和空格,最大长度64个字符。
orgunit使用者所在的部门,非必配参数。支持字母、数字、连字符、下划线、句点和空格,最大长度64个字符。

使用指南

无

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR

X-Auth-Token: auth_value Content-Type: header_type 请求消息体:

json
{
"Country": country,
"CommonName": commonname,
"City": city,
"State": state,
"OrgName": orgname,
"OrgUnit": orgunit
}

响应样例:

json
{
"@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/1",
"Id": "1",
"Name": "csr generation task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2016-07-10T11:31:02+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}

响应码:202

POST (ACTION) ​

ExportCSR ​

命令功能

导出 CSR

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR

请求头:

text
X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
"Type": type_value,
"Content": Content
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
type_value导出类型● URI
Content导出文件路径支持导出到本地路径和远程路径(本地路径必须在tmp目录下)

使用指南

无

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR

X-Auth-Token: auth_value Content-Type: header_type 请求消息体:

json
{
"Type": type_value,
"Content": Content
}

响应样例:

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

POST (ACTION) ​

ImportServerCertificate ​

命令功能

导入服务器证书

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate

请求头:

text
X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
"Certificate": text_value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
text_value服务器证书文件或证书链文件BASE64编码的证书文件的内容

使用指南

无

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate

X-Auth-Token: auth_value Content-Type: header_type 请求消息体:

json
{
"Certificate": text_value
}

响应样例:

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": "iBMC.1.0.CertImportOK",
"RelatedProperties": [],
"Message": "The certificate has been imported successfully.",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "Restart the iBMC for the certificate to take effect."
}
]
}
}

响应码:200

POST (ACTION) ​

ImportCustomCertificate ​

命令功能

导入自定义证书

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate

请求头:

text
X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
"Certificate": text_value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
text_value自定义证书文件或自定义证书链文件BASE64编码的证书文件内容

使用指南

无

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate

X-Auth-Token: auth_value Content-Type: header_type 请求消息体:

json
{
"Certificate": text_value
}

响应样例:

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": "iBMC.1.0.CertImportOK",
"RelatedProperties": [],
"Message": "The certificate has been imported successfully.",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "Restart the iBMC for the certificate to take effect."
}
]
}
}

响应码:200