Generating sessions

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request generates sessions and manages the sessions on the REST API server. A maximum of 64 sessions can be generated for each storage system. When the number of sessions exceeds the maximum number of sessions, the HTTP status code 503 is returned. In this case, wait a while and then run the request again.
Note: For remote copy, specify at least 60 seconds for the aliveTime attribute of the sessions generated on the remote storage system. If you specify less than 60 seconds, the session on the remote storage system might time out, causing the execution of a request to fail.

Execution permission

Storage Administrator (View Only)

Request line

POST base-URL/v1/objects/sessions

Request message

Object ID
None.
Query parameters
None.
Body

The following coding example specifies the time until a session timeout:

{
  "aliveTime": 5
}

Attribute

Type

Description

aliveTime

long

(Optional) Session timeout value (in seconds)

Specify a value in the range from 1 to 300#.

If this attribute is omitted, 300 is assumed.

authenticationTimeout

long

(Optional) Timeout value for authentication processing (in seconds)

Specify this value if an external authentication server is being used to authenticate users.

Change the value according to the external authentication settings of the storage system.

Specify a value in the range from 1 to 900.

If this attribute is omitted, 120 is assumed.

#: There might be a delay of up to five seconds after the specified amount of time has elapsed, before the session times out.

Response message

Body
{
  "token": "d7b673af189048468c5af9bcf3bbbb6f",
  "sessionId": 3
}

Attribute

Type

Description

sessionId

int

Session ID

An ID that is used to manage sessions.

token

string

Token

Information that is used to identify the source that issues requests as a specific user.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -u rest-test:rest-api -X POST https://192.0.2.100/ConfigurationManager/v1/objects/sessions/ -d ""