HP 3PAR StoreServ 7450 4-node HP 3PAR Web Service API 1.2 Developer's - Page 58

Removing a Host, Host Removal Success, Querying Hosts, Host Query Success

Page 58 highlights

Table 46 Host Modification Error Codes (continued) API Error HTTP Code EXPORTED_VLUN 409 Conflict NON_EXISTENT_PATH LUN_HOSTPERSONA_CONFLICT 400 Bad Request 409 Conflict INV_INPUT_DUP_PATH 404 Bad Request Description Setting persona with active export; remove a host path on an active export. Removing a non-existent path. LUN number and persona capability conflict. Duplicate path specified. Removing a Host To remove a host, use the HTTP DELETE method. Use the following URI: https://:8080/api/v1/hosts/ NOTE: Any user with Super or Edit role, or any role granted the host_remove right, can perform this operation. Access to all domains is required for this operation. Host Removal Success Upon success, the HTTP code 200 OK is returned with no message body. Host Removal Errors Table 47 (page 58) shows the errors that can occur following a request for host removal. For generic API error codes, see Table 5 (page 17). Table 47 Host Removal Error Codes API Error NON_EXISTENT_HOST HOST_IN_SET HTTP Code 404 Not Found 409 Conflict Description Host not found. Host is a member of a set. (Since WSAPI 1.2) Querying Hosts Query hosts using the HTTP GET method. Use the following URI with no message body: https://:8080/api/v1/hosts To query a single host, use the following URI with no message body: https://:8080/api/v1/hosts/ Host Query Success Unless an error occurs, the response will include a message body that is a JSON array of zero or more JSON objects, as shown in Table 48 (page 58). Table 48 Host Query JSON Objects Member name JSON Type string API Type name31 Description Specifies the name of the host. (Since WSAPI 1.2) persona number HostPersona Enum ID of the persona to assigned to the host. 58 Working with Hosts

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107

Table 46 Host Modification Error Codes
(continued)
Description
HTTP Code
API Error
Setting persona with active export;
remove a host path on an active export.
409 Conflict
EXPORTED_VLUN
Removing a non-existent path.
400 Bad Request
NON_EXISTENT_PATH
LUN number and persona capability
conflict.
409 Conflict
LUN_HOSTPERSONA_CONFLICT
Duplicate path specified.
404 Bad Request
INV_INPUT_DUP_PATH
Removing a Host
To remove a host, use the HTTP DELETE method. Use the following URI:
https://
<storage system>
:8080/api/v1/hosts/
<host-name>
NOTE:
Any user with Super or Edit role, or any role granted the
host_remove
right, can perform
this operation. Access to all domains is required for this operation.
Host Removal Success
Upon success, the HTTP code
200 OK
is returned with no message body.
Host Removal Errors
Table 47 (page 58)
shows the errors that can occur following a request for host removal. For
generic API error codes, see
Table 5 (page 17)
.
Table 47 Host Removal Error Codes
Description
HTTP Code
API Error
Host not found.
404 Not Found
NON_EXISTENT_HOST
Host is a member of a set.
409 Conflict
HOST_IN_SET
(Since WSAPI 1.2)
Querying Hosts
Query hosts using the HTTP GET method. Use the following URI with no message body:
https://
<storage system>
:8080/api/v1/hosts
To query a single host, use the following URI with no message body:
https://
<storage system>
:8080/api/v1/hosts/
<host name>
Host Query Success
Unless an error occurs, the response will include a message body that is a JSON array of zero or
more JSON objects, as shown in
Table 48 (page 58)
.
Table 48 Host Query JSON Objects
Description
API Type
JSON Type
Member
Specifies the name of the
host.
name31
string
name
(Since WSAPI 1.2)
ID of the persona to
assigned to the host.
HostPersona Enum
number
persona
58
Working with Hosts