Querying SSL Certificate Resource Information
Function
This interface is used to query all the SSL certificates supported.
Syntax
Operation type: GET
URL: https://device_ip/redfish/v1/EdgeSystem/SecurityService/HttpsCert
Request header:
X-Auth-Token: auth_value
Request message body: None
Parameters
Parameter |
Description |
Value |
|---|---|---|
device_ip |
IP address for logging in to a device. |
An IPv4 or IPv6 address. |
auth_value |
Authentication parameter contained in the request. |
You can obtain the value from the session created by using /redfish/v1/SessionService/Sessions. |
Usage Guidelines
None
Example
Request:
GET https://10.10.10.10/redfish/v1/EdgeSystem/SecurityService/HttpsCert
Request header:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Request message body: None
Response:
{
"@odata.context": "/redfish/v1/$metadata#EdgeSystem/SecurityService/HttpsCert/$entity",
"@odata.id": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert",
"@odata.type": "#HttpsCert.v1_0_0.HttpsCert",
"Id": "HttpsCert",
"Name": "Https cert info",
"X509CertificateInformation": {
"ServerCert": {
"Subject": "CN=Server, OU=IT, O=Huawei, L=ShenZhen, S=GuangDong, C=CN",
"Issuer": "CN=Server, OU=IT, O=Huawei, L=ShenZhen, S=GuangDong, C=CN",
"ValidNotBefore": "Jul 25 2014 GMT",
"ValidNotAfter": "Jul 22 2024 GMT",
"SerialNumber": "07 "
"HttpsCertEable": "",
"ExpiredDayRemaining": null
}
},
"CertificateSigningRequest": null,
"Actions": {
"#HttpsCert.GenerateCSR": {
"target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR",
"@Redfish.ActionInfo": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/GenerateCSRActionInfo"
},
"#HttpsCert.ImportServerCertificate": {
"target": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate",
"@Redfish.ActionInfo": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/ImportServerCertificateActionInfo"
},
"#HttpsCert.ImportCustomCertificate": {
"target": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate",
"@Redfish.ActionInfo": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/ImportCustomCertificateActionInfo"
},
"#HttpsCert.ExportCSR": {
"target": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR",
"@Redfish.ActionInfo": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert/ExportCSRActionInfo"
}
}
}
Response code: 202
Output Description
Attribute |
Type |
Description |
|---|---|---|
@odata.context |
Character string |
OData description information of an SSL certificate resource model. |
@odata.id |
Character string |
Access path of an SSL certificate resource node. |
@odata.type |
Character string |
Type of an SSL certificate resource. |
Id |
Character string |
ID of an SSL certificate resource. |
Name |
Character string |
Name of an SSL certificate resource. |
X509CertificateInformation |
Object |
SSL certificate information. |
ServerCert.Subject |
Character string |
User of the certificate. |
ServerCert.Issuer |
Character string |
Authority that issues the certificate. |
ServerCert.ValidNotBefore |
Character string |
Date from which the certificate is valid. |
ServerCert.ValidNotAfter |
Character string |
Expiry date of the certificate. |
ServerCert.SerialNumber |
Character string |
Certificate SN. |
HttpsCertEable |
Character string |
Whether to enable the certificate. |
ExpiredDayRemaining |
Character string |
Certificate validity period. |
CertificateSigningRequest |
Character string |
CSR information. NOTE:
After the server certificate is imported, the CSR information generated previously is cleared, and null is displayed. |
Actions |
Object |
Operations that can be performed. |
Actions.#HttpsCert.GenerateCSR |
Object |
Path of the CSR file generated. |
Actions.#HttpsCert.ImportServerCertificate |
Object |
Directory in which the server certificate is to be imported. |
Actions.HttpsCert.ImportCustomCertificate |
Object |
Directory in which the custom certificate is to be imported. |
Actions.HttpsCert.ExportCSR |
Object |
CSR file to be exported. |
