Querying Statistics of All Running Instances
Function
This API is used to query the statistics of all DCS instances that are in the Running state.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/statistic
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: N/A. Default value: N/A. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
statistics |
Array of InstanceStatistic objects |
Parameter description: Statistics of all instances in the Running state. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
input_kbps |
String |
Parameter description: Incoming traffic (Kbit/s) of the DCS instance. Value range: N/A. |
output_kbps |
String |
Parameter description: Outgoing traffic (Kbit/s) of the DCS instance. Value range: N/A. |
instance_id |
String |
Parameter description: Instance ID. Value range: N/A. |
keys |
Long |
Parameter description: Number of cached data records. Value range: N/A. |
used_memory |
Long |
Parameter description: Used memory size in MB. Value range: N/A. |
max_memory |
Long |
Parameter description: Total memory size in MB. Value range: N/A. |
cmd_get_count |
Long |
Parameter description: Number of times the GET command is run. Value range: N/A. |
cmd_set_count |
Long |
Parameter description: Number of times the SET command is run. Value range: N/A. |
used_cpu |
String |
Parameter description: Accumulated CPU time consumed by the cache in the user state and kernel state, in seconds. Value range: N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/statistic
Example Responses
Status code: 200
Instance statistics queried successfully.
{ "statistics" : [ { "output_kbps" : "0.0", "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.0", "max_memory" : 460 }, { "output_kbps" : "0.0", "instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.0", "max_memory" : 460 }, { "output_kbps" : "1.19", "instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.03", "max_memory" : 460 }, { "output_kbps" : "0.0", "instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.0", "max_memory" : 6963 } ] }
SDK Sample Code
The SDK sample code is as follows.
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 |
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 ListStatisticsOfRunningInstancesSolution { 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(); ListStatisticsOfRunningInstancesRequest request = new ListStatisticsOfRunningInstancesRequest(); try { ListStatisticsOfRunningInstancesResponse response = client.listStatisticsOfRunningInstances(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()); } } } |
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 |
# 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 = ListStatisticsOfRunningInstancesRequest() response = client.list_statistics_of_running_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListStatisticsOfRunningInstancesRequest{} response, err := client.ListStatisticsOfRunningInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Instance statistics queried successfully. |
400 |
Invalid request. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot