Querying Sessions
Function
This API is used to query sessions.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v2/{project_id}/instances/{instance_id}/clients
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| instance_id | Yes | String | Definition Instance ID. Constraints The specified ID must be a DCS instance ID that exists in the current tenant. Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| node_id | No | String | Definition ID of the node where sessions are to be queried. If this parameter is left empty, sessions on all nodes of the instance are queried. Constraints The specified node ID must exist in the instance. Otherwise, the error message INSTANCE_NODE_NOT_FOUND is returned. Range N/A Default Value N/A |
| clean_cache | No | Boolean | Definition Whether to re-query and save the session list. Constraints N/A Range Default Value false |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | Definition Job ID of an asynchronous query task. Session list scanning is an asynchronous task. After the POST request is triggered, job_id is returned. You can use job_id to query the task status. clean_cache is set to true. Range N/A |
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."
} SDK Sample Code
The SDK sample code is as follows.
Java
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 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ScanClientsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ScanClientsRequest request = new ScanClientsRequest(); request.withInstanceId("{instance_id}"); ScanClientsRequestBody body = new ScanClientsRequestBody(); body.withCleanCache(true); body.withNodeId("8f7ee181-88e2-49b7-a4bf-81f18f93a135"); request.withBody(body); try { ScanClientsResponse response = client.scanClients(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ScanClientsRequest() request.instance_id = "{instance_id}" request.body = ScanClientsRequestBody( clean_cache=True, node_id="8f7ee181-88e2-49b7-a4bf-81f18f93a135" ) response = client.scan_clients(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.ScanClientsRequest{} request.InstanceId = "{instance_id}" cleanCacheScanClientsRequestBody:= true nodeIdScanClientsRequestBody:= "8f7ee181-88e2-49b7-a4bf-81f18f93a135" request.Body = &model.ScanClientsRequestBody{ CleanCache: &cleanCacheScanClientsRequestBody, NodeId: &nodeIdScanClientsRequestBody, } response, err := client.ScanClients(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot