Read

GET v1/chap_users

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID
name NsObjectName
full_name NsObjectName
search_name NsSearchName
description NsDescription
creation_time NsTime
last_modified NsTime
vol_count NsUnsignedLong

GET v1/chap_users/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID
name NsObjectName
full_name NsObjectName
search_name NsSearchName
description NsDescription
creation_time NsTime
last_modified NsTime
vol_count NsUnsignedLong

GET v1/chap_users/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

List a set of CHAP users or a single CHAP user.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for the CHAP user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsObjectName string Name of CHAP user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
full_name NsObjectName string CHAP user's fully qualified name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
search_name NsSearchName string CHAP user name used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.  
description NsDescription string Text description of CHAP user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
creation_time NsTime number Time when this CHAP user was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this CHAP user was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
vol_list NsVolumeList Array of NsVolumeSummary List of volumes associated with this CHAP user. List of volumes.  
vol_count NsUnsignedLong number Count of volumes associated with this CHAP user. Unsigned 64-bit integer. Example: 1234.  

JSON Response 


            

{
   "data" : {
      "search_name" : "chapuser0.692928845369355",
      "name" : "chapuser0.692928845369355",
      "last_modified" : 1426776473,
      "id" : "0100000000000004d3000000000000000000000001",
      "creation_time" : 1426776473,
      "full_name" : "",
      "description" : ""
   }
}