GET /aicc/service/sftp/locks
Use this method to return a list of all SFTP service locks. The SFTP service is disabled by default.
Note
This REST API requires Lenovo XClarity Administrator v4.1.0 or later.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/aicc/service/sftp/locks
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 204 | No Content | The request completed successfully, but no response content is returned. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| id | String | Lock ID. The ID is a 32 character string containing numbers and letters. | ||
| component | String | Predefined Lenovo XClarity Administrator component ID. This can be one of the following values.
| ||
| creationTimestamp | String | Timestamp when the lock was created This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | ||
| expirationTimeOut | Integer | Number of seconds after which the lock expires When the lock expires, the lock ID is deleted and if there are no other locks, the SFTP service is stopped (disabled). | ||
The following example is returned if the request is successful.
[{
"id": "AB3L4N5L6N9D8FVLSDLS0S223JSNLSE3",
"component": "UP",
"creationTimestamp": "2022-09-09T01:46:08Z",
"expirationTimeOut": 1200
},
{
"id": "FE3L4N5L6N9D8FVLSDLS0S223JSNLSE3",
"component": "UP",
"creationTimestamp": "2022-09-09T01:46:12Z",
"expirationTimeOut": 1200
}]
Give documentation feedback