Querying Sessions
Function
This API is used to query sessions.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/instances/{instance_id}/clients
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| node_id | Yes | String | Node ID. |
| clean_cache | No | Boolean | Indicates whether to re-query and save the session list. |
Response Parameters
Status code: 200
Successful
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Error message details. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Error message details. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Error message details. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Error message details. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error message. |
| error_code | String | Error code. |
| error_ext_msg | String | Error message details. |
Example Requests
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/clients
{
"node_id" : "8f7ee181-88e2-49b7-a4bf-81f18f93a135",
"clean_cache" : true
} Example Responses
Status code: 200
Successful
{
"job_id" : "8abf6e1e824e204401824e3e621b0042"
} Status code: 400
Invalid request.
{
"error_code" : "DCS.4957",
"error_msg" : "This operation is not allowed when the task is in the current state."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Successful |
| 400 | Invalid request. |
| 401 | Invalid authentication information. |
| 403 | Access denied. |
| 404 | The requested resource could not be found. |
| 500 | Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
