PowerStore: как использовать API-интерфейс REST PowerStore

Résumé: В этой статье представлены основные сведения о REST API системы PowerStore, включая примеры практического использования и распространенные ошибки.

Cet article concerne Cet article ne concerne pas Cet article n’est associé à aucun produit spécifique. Toutes les versions du produit ne sont pas identifiées dans cet article.

Instructions

Для тестирования REST API можно использовать несколько инструментов, включая Postman, HTTPie и cURL. В этой статье cURL используется для всех примеров, поскольку он легко доступен в большинстве операционных систем по умолчанию.
 
Общее использование API-интерфейса REST.

 

Работоспособность узла:
curl -H "Принять: приложение/json" -u "admin:********" -X GET -k https://xx.xx.xx.xx/api/rest/hardware?select=id,name,type,lifecycle_state?type=eq.Node

Примеры выходных данных:

{"id":"00b941ceea9243f0a36e85abe9504214","name":"BaseEnclosure-NodeB","type":"Node","lifecycle_state":"Healthy"},
{"id":"2877d096fd2a4cc4b3b8af97f21c1c24","name":"BaseEnclosure-NodeA","type":"Node","lifecycle_state:"Healthy"}

 

Состояние репликации:
curl -H "Принять: приложение/json" -u "admin:********" -X GET -k https://xx.xx.xx.xx/api/rest/replication_session?select=id,role,state,last_sync_timestamp,local_resource_id

Примеры выходных данных:

{"id":"047e38ee-9aeb-4761-8ca5-393204fe6584","role":"Metro_Preferred","state":"OK","last_sync_timestamp":"2026-07-16T15:48:05.628263+00:00","local_resource_id":"d34bd80e-1d43-4692-ab37-e307bc92eb73"},
{"id":"26dd4105-a24f-4d82-b40b-20dcefbfe5df","role":"Source","state":"OK","last_sync_timestamp":"2026-07-16T15:31:54.64127+00:00","local_resource_id":"82c40277-dee4-46de-8559-920fe5f942cc"},
{"id":"414dba20-08b1-4d5e-a521-517a3b37473a","role":"Metro_Preferred","state":"OK","last_sync_timestamp":"2026-07-16T15:51:05.525764+00:00","local_resource_id":"eb970724-cc3e-4661-8d71-bec7f44baf10"}

 

Системное оповещение:
curl -H "Принять: приложение/json" -u "admin:********" -X GET -k https://xx.xx.xx.xx/api/rest/alert?select=id,event_code,severity,resource_type,generated_timestamp,state,description_l10n

Примеры выходных данных:

{"id":"008abb47-e72d-4608-b915-b8c01328b64e","event_code":"0x01700304","серьезность":"Major","resource_type":"remote_system","generated_timestamp":"2026-05-11T01:51:01.280627+00:00","state":"ACTIVE","description_l10n":"Все подключения для передачи данных от удаленной системы Ghost отключены."},
{"id":"01114811-82a9-484e-8cf9-3da50c0e3d7b","event_code":"0x01701801","severity":"Info","resource_type":"volume","generated_timestamp":"2026-07-14T02:15:34.764524+00:00","state":"CLEARED","description_l10n":"Свидетель Metro, настроенный для ресурса HyperV-Node1, задействован."}

 

События аудита:
curl -H "Принять: application/json" -u "admin:********" -X GET -k https://xx.xx.xx.xx/api/rest/audit_event?select=id,type,timestamp,username,resource_type,resource_action,message_l10n,client_address

Вывод может быть огромным и нуждаться в фильтре. Например, для просмотра событий, связанных с администрированием пользователя. try:
curl -h "accept: application/json" -u "admin:********" -x GET -k https://xx.xx.xx.xx/api/rest/audit_event?select=id,type,timestamp,username,resource_type,resource_action,message_l10n,client_address?username=eq.admin

Примеры выходных данных:

{"id":"111540","type":"Config","timestamp":"2026-03-11T20:25:57.267124+00:00","username":"admin","resource_type":"host","resource_action":"delete","message_l10n":"Успешно удален хост с именем: Thors 183.24 (iSCSI) и идентификатором: c698f28b-49ac-4268-a9c7-c6da66bdfbc8.","client_address":"10.158.49.47"},
{"id":"111541","type":"Config","timestamp":"2026-03-11T20:25:57.337655+00:00","username":"admin","resource_type":"host","resource_action:"delete"," message_l10n":"Успешно удалены метаданные с ключами: [], связанными с ресурсом с типом: host и ID: c698f28b-49ac-4268-a9c7-c6da66bdfbc8.","client_address":"10.158.49.47"}

 

Список моментальных снимков:
curl -H "Принять: application/json" -u "admin:********" -X GET -k https://xx.xx.xx.xx/api/rest/volume_snap_list_cma_view?select=id,name,source_timestamp,description,creation_timestamp

Примеры выходных данных:
{"id":"24d7856d-d389-4f05-9752-ebb1de61a6d6","name":"Walid Snaps.PowerTriage-RHEL (Walid НЕ УДАЛЯТЬ).2026-07-15T00:00:00Z 189403910","source_timestamp":"2026-07-15T00:03:16.096762+00:00","description":"","creation_timestamp":"2026-07-15T00:03:16.096762+00:00"},
{"id":"2cfd727f-b09c-4895-8fd5-93850fd63698","name":"Daily-File.7DSL0M2-1-001.2026-07-14T00:08:08Z 281536767","source_timestamp":"2026-07-14T00:08:08.618343+00:00"," description":null,"creation_timestamp":"2026-07-14T00:08:08.618343+00:00"}

 

Метрики производительности:
curl -H "Принять: application/json" -H "Content-Type: application/json" -u "admin:********" -X POST -k https://xx.xx.xx.xx/api/rest/metrics/generate -d '{ "entity": "performance_metrics_by_appliance", "entity_id": "A1","interval": "One_Day" }'|jq '.'

Примеры выходных данных:


{ "appliance_id": "A1", "timestamp":
"2026-07-15T00:00:00Z",
"avg_read_latency": 172.76094,
"avg_write_latency": 404.14536,
"avg_mirror_write_latency": 924.59375,
"avg_mirror_overhead_latency": 364.82297,
"avg_latency": 273.2135,
"avg_read_size": 91601.2,
"avg_write_size": 6204.5635,
"avg_io_size": 54527.355,
"avg_read_iops": 9.996701, "avg_write_iops":
7.669595,
"avg_mirror_write_iops": 0.024386574,
  "avg_total_iops": 17.666296, "avg_read_bandwidth":
915709.9,
"avg_write_bandwidth": 47586.49,
"avg_mirror_write_bandwidth": 190.67259,
"avg_total_bandwidth": 963296.4,
"avg_io_workload_cpu_utilization": 0.00399437453597784,
"max_avg_read_latency": 401.14688,
"max_avg_write_latency": 1679.9584,
"max_avg_latency": 652.1067,
"max_avg_mirror_write_latency": 3842,
"max_avg_mirror_overhead_latency": 3319,
  "max_avg_read_size": 99656.45,
"max_avg_write_size": 30189.037,
"max_avg_io_size": 85726.97,
"max_read_iops": 161.2,
"max_write_iops": 680.6,
"max_mirror_write_iops": 3.8,
"max_total_iops": 834,
"max_read_bandwidth": 8509440,
"max_write_bandwidth": 8792986, "max_mirror_write_bandwidth":
22732.8,
"max_total_bandwidth": 17252044,
"max_io_workload_cpu_utilization": 0.2170485556125641,
"repeat_count": 1,

  ...

  "response_definition": "performance_metrics_by_appliance_rollup", "entity":
"performance_metrics_by_appliance"
}

 

Распространенные ошибки при использовании Rest API:

Добавление "-v" к команде curl, чтобы отобразить ошибку. 

Пример 1: неверные учетные данные.

curl -H "Принять: приложение/json" -u "admin:wrong_password" -k https://10.241.219.160/api/rest/hardware?select=id,name,type,lifecycle_state?type=eq.Node

* Запрос полностью отправлен
* TLSv1.3 (IN), подтверждение подключения TLS, Newsession Ticket (4):
< HTTP/1.1 401 Неавторизованная
< WWW-аутентификация: SSOCustom realm="Cyclone Realm"
< Тип содержимого: Application/JSON
< Content-length: 0

Пример 2: httpd не запущен.

curl -v -H "Accept: application/json" -u "admin:********" -k https://xx.xx.xx.xx/api/rest/hardware?select=id,name,type,lifecycle_state?type=eq.Node
* Попытка xx.xx.xx.xx:443...
* Подключение к порту xx.xx.xx.xx 443 через порт xx.xx.xx.xx Сбой 59124: истекло время
ожидания подключения* Не удалось подключиться к порту xx.xx.xx.xx 443 после 31939 мс: не удалось подключиться к серверу
* Закрытие соединения #0
curl: (28) Не удалось подключиться к порту xx.xx.xx.xx 443 через 31939 мс: не удалось подключиться к серверу

Пример 3: неправильный синтаксис без типа содержимого.

curl -v -H "Accept: application/json" -u "admin:********" -X POST -k https://xx.xx.xx.xx/api/rest/metrics/generate -d '{ "entity": "performance_metrics_by_appliance", "entity_id": "A1","interval": "One_Day" }'
{"messages":[{"severity":"Error","code":"0xE04040030001","message_l10n":"Validation failed: заголовок Request Content-Type '[application/x-www-form-urlencoded]' не соответствует ни одному разрешенному типу. Должно быть одним из: [application/json]., Тело запроса требуется, но не найдено..","arguments":[{"delimiter":", ","messages":[{"severity":"Error","code":"validation.request.contentType.notAllowed","message_l10n":"Заголовок Request Content-Type '[application/x-www-form-urlencoded]' не соответствует ни одному разрешенному типу. Должно быть одним из: [application/json].","arguments":["[application/x-www-form-urlencoded]","[application/json]"]},{"severity":"Error","code":"validation.request.body.missing","message_l10n":"Тело запроса требуется, но не найдено."}]}]}]}

 

Полезные ссылки

https://dl.dell.com/content/manual55475248-dell-powerstore-rest-api-developers-guide.pdf?language=en-us

https://< PWST_CLUSTER_IP>/swaggerui/

 

Produits concernés

PowerStore, PowerStoreOS
Propriétés de l’article
Numéro d’article: 000490125
Type d’article: How To
Dernière modification: 31 juil. 2026
Version:  2
Trouvez des réponses à vos questions auprès d’autres utilisateurs Dell
Services de support
Vérifiez si votre appareil est couvert par les services de support.