Querying DCS Instance Statuses
Function
This API is used to query the number of instances in different states.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/status
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
include_failure |
No |
String |
Parameter description: Whether to return the number of instances that fail to be created. Constraints: N/A. Value range:
Default value: false |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
redis |
StatusStatistic object |
Parameter description: Redis instance quantity statistics. Value range: N/A. |
memcached |
StatusStatistic object |
Parameter description: Memcached instance quantity statistics. Value range: N/A. |
paying_count |
Integer |
Parameter description: Number of instances for which payment is in progress. Value range: N/A. |
freezing_count |
Integer |
Parameter description: Number of instances that are being frozen. Value range: N/A. |
migrating_count |
Integer |
Parameter description: Number of instances on which data migration is in progress. Value range: N/A. |
flushing_count |
Integer |
Parameter description: Number of instances whose data is being cleared. Value range: N/A. |
upgrading_count |
Integer |
Parameter description: Number of instances that are being upgraded. Value range: N/A. |
restoring_count |
Integer |
Parameter description: Number of instances for which data restoration is in progress. Value range: N/A. |
extending_count |
Integer |
Parameter description: Number of instances that are being scaled up. Value range: N/A. |
creating_count |
Integer |
Parameter description: Number of instances that are being created. Value range: N/A. |
running_count |
Integer |
Parameter description: Number of running instances. Value range: N/A. |
error_count |
Integer |
Parameter description: Number of abnormal instances. Value range: N/A. |
frozen_count |
Integer |
Parameter description: Number of frozen instances. Value range: N/A. |
createfailed_count |
Integer |
Parameter description: Number of instances that fail to be created. Value range: N/A. |
restarting_count |
Integer |
Parameter description: Number of instances that are being restarted. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
paying_count |
Integer |
Parameter description: Number of instances for which payment is in progress. Value range: N/A. |
freezing_count |
Integer |
Parameter description: Number of instances that are being frozen. Value range: N/A. |
migrating_count |
Integer |
Parameter description: Number of instances on which data migration is in progress. Value range: N/A. |
flushing_count |
Integer |
Parameter description: Number of instances whose data is being cleared. Value range: N/A. |
upgrading_count |
Integer |
Parameter description: Number of instances that are being upgraded. Value range: N/A. |
restoring_count |
Integer |
Parameter description: Number of instances for which data restoration is in progress. Value range: N/A. |
extending_count |
Integer |
Parameter description: Number of instances that are being scaled up. Value range: N/A. |
creating_count |
Integer |
Parameter description: Number of instances that are being created. Value range: N/A. |
running_count |
Integer |
Parameter description: Number of running instances. Value range: N/A. |
error_count |
Integer |
Parameter description: Number of abnormal instances. Value range: N/A. |
frozen_count |
Integer |
Parameter description: Number of instances that have been frozen. Value range: N/A. |
createfailed_count |
Integer |
Parameter description: Number of instances that fail to be created. Value range: N/A. |
restarting_count |
Integer |
Parameter description: Number of instances that are being restarted. 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/status?include_failure=true
Example Responses
Status code: 200
DCS instance quantity queried successfully.
{ "extending_count" : 0, "creating_count" : 0, "running_count" : 16, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 44, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0, "redis" : { "extending_count" : 0, "creating_count" : 0, "running_count" : 8, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 22, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0 }, "memcached" : { "extending_count" : 0, "creating_count" : 0, "running_count" : 8, "error_count" : 0, "frozen_count" : 0, "createfailed_count" : 22, "restarting_count" : 0, "paying_count" : 0, "freezing_count" : 0, "migrating_count" : 0, "flushing_count" : 0, "upgrading_count" : 0 } }
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 ListNumberOfInstancesInDifferentStatusSolution { 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(); ListNumberOfInstancesInDifferentStatusRequest request = new ListNumberOfInstancesInDifferentStatusRequest(); try { ListNumberOfInstancesInDifferentStatusResponse response = client.listNumberOfInstancesInDifferentStatus(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 = ListNumberOfInstancesInDifferentStatusRequest() response = client.list_number_of_instances_in_different_status(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.ListNumberOfInstancesInDifferentStatusRequest{} response, err := client.ListNumberOfInstancesInDifferentStatus(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 |
DCS instance quantity 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