Download OpenAPI specification:Download
This API, used by the HPE CSI driver, enables management of resources used for container workloads. It is not intended for direct usage outside of the CSI driver but is provided here for documentation purposes.
Success
Unauthorized
Internal Server Error
[- {
- "id": "string",
- "name": "string",
- "uuid": "string",
- "iqns": [
- "string"
], - "wwpns": [
- "string"
], - "networks": [
- "string"
], - "chap_user": "string",
- "chap_password": "string"
}
]
Success
Bad Request
Unauthorized
Internal Server Error
{- "name": "string",
- "uuid": "string",
- "iqns": [
- "string"
], - "wwpns": [
- "string"
], - "networks": [
- "string"
], - "chap_user": "string",
- "chap_password": "string"
}
{- "id": "string",
- "name": "string",
- "uuid": "string",
- "iqns": [
- "string"
], - "wwpns": [
- "string"
], - "networks": [
- "string"
], - "chap_user": "string",
- "chap_password": "string"
}
Success
Unauthorized
Replication partner name not found
Internal Server Error
[- {
- "alive": true,
- "id": "string",
- "name": "string",
- "repl_role": "upstream",
- "is_alive": true
}
]
Success
Bad Request if volume group ID is not provided
Unauthorized
Internal Server Error
[- {
- "id": "string",
- "name": "string",
- "snapshots": [
- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
], - "config": {
- "replicate": true,
- "is_complete": true,
- "repl_status": "fail",
- "repl_complete_time": 0,
- "repl_start_time": 0
}, - "volume_group_id": "string",
- "volume_group_name": "string",
- "creation_time": 0
}
]
Success
Bad Request
Unauthorized
Internal Server Error
{- "name": "string",
- "snapshots": [
- {
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
], - "config": {
- "replicate": true,
- "is_complete": true,
- "repl_status": "fail",
- "repl_complete_time": 0,
- "repl_start_time": 0
}, - "volume_group_id": "string",
- "volume_group_name": "string",
- "creation_time": 0
}
{- "id": "string",
- "name": "string",
- "snapshots": [
- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
], - "config": {
- "replicate": true,
- "is_complete": true,
- "repl_status": "fail",
- "repl_complete_time": 0,
- "repl_start_time": 0
}, - "volume_group_id": "string",
- "volume_group_name": "string",
- "creation_time": 0
}
Success
Bad Request
Unauthorized
Snapshot group ID not found
Internal Server Error
{- "id": "string",
- "name": "string",
- "snapshots": [
- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
], - "config": {
- "replicate": true,
- "is_complete": true,
- "repl_status": "fail",
- "repl_complete_time": 0,
- "repl_start_time": 0
}, - "volume_group_id": "string",
- "volume_group_name": "string",
- "creation_time": 0
}
Success
Bad Request if volume group ID is not provided
Unauthorized
Not Found if volume ID or snapshot name cannot be found
Internal Server Error
[- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
]
Success
Bad Request
Unauthorized
Internal Server Error
{- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
{- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
Success
Bad Request
Unauthorized
Not Found if snapshot ID cannot be found
Internal Server Error
{- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "config": {
- "property1": null,
- "property2": null
}, - "volume_id": "string",
- "volume_name": "string",
- "creation_time": 0,
- "ready_to_use": true
}
Success
Bad Request
Invalid username and/or password
Internal Server Error
{- "username": "string",
- "password": "string",
- "array_ip": "string",
- "session_token": "string",
- "creation_time": 0,
- "expiry_time": 0
}
{- "id": "string",
- "username": "string",
- "password": "string",
- "array_ip": "string",
- "session_token": "string",
- "creation_time": 0,
- "expiry_time": 0
}
Success
Unauthorized
Not Found if the volume group name cannot be found
Internal Server Error
[- {
- "id": "string",
- "name": "string",
- "description": "string",
- "config": {
- "replication_partner": "string",
- "protection_template": "string"
}, - "volumes": [
- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
], - "creation_time": 0
}
]
Success
Bad Request
Unauthorized
Internal Server Error
{- "name": "string",
- "description": "string",
- "config": {
- "replication_partner": "string",
- "protection_template": "string"
}, - "volumes": [
- {
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
], - "creation_time": 0
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "config": {
- "replication_partner": "string",
- "protection_template": "string"
}, - "volumes": [
- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
], - "creation_time": 0
}
Success
Bad Request
Unauthorized
Not Found if volume group ID cannot be found
Internal Server Error
{- "id": "string",
- "name": "string",
- "description": "string",
- "config": {
- "replication_partner": "string",
- "protection_template": "string"
}, - "volumes": [
- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
], - "creation_time": 0
}
Success
Unauthorized
Not Found if the volume name cannot be found
Internal Server Error
[- {
- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
]
Success
Bad Request
Unauthorized
Internal Server Error
{- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
{- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
Success
Bad Request
Unauthorized
Not Found if volume ID cannot be found
Internal Server Error
{- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
Success
Bad Request
Unauthorized
Not Found if volume ID cannot be found
Internal Server Error
{- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
{- "id": "string",
- "name": "string",
- "size": 0,
- "description": "string",
- "clone": true,
- "published": true,
- "config": {
- "property1": null,
- "property2": null
}, - "base_snapshot_id": "string",
- "volume_group_id": "string"
}
Volume published successfully
Bad Request
Unauthorized
Not found if volume ID or host UUID is not found
Internal Server Error
{- "host_uuid": "string",
- "access_protocol": "iscsi"
}
{- "serial_number": "string",
- "target_names": [
- "string"
], - "access_protocol": "iscsi",
- "lun_id": 0,
- "discovery_ips": [
- "string"
], - "chap_user": "string",
- "chap_password": "string"
}
Volume unpublished successfully
Bad Request
Unauthorized
Not found if volume ID or host UUID cannot be found
Internal Server Error
{- "host_uuid": "string"
}
{- "serial_number": "string",
- "target_names": [
- "string"
], - "access_protocol": "iscsi",
- "lun_id": 0,
- "discovery_ips": [
- "string"
], - "chap_user": "string",
- "chap_password": "string"
}