查询实例状态
功能介绍
查询该租户在当前区域下不同状态的实例数。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/status
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
include_failure |
否 |
String |
参数解释: 是否返回创建失败的实例数。 约束限制: 不涉及。 取值范围:
默认取值: false |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
redis |
StatusStatistic object |
参数解释: Redis实例数量统计信息。 取值范围: 不涉及。 |
memcached |
StatusStatistic object |
参数解释: Memcached实例数量统计信息。 取值范围: 不涉及。 |
paying_count |
Integer |
参数解释: 支付中的实例数。 取值范围: 不涉及。 |
freezing_count |
Integer |
参数解释: 冻结中的实例数。 取值范围: 不涉及。 |
migrating_count |
Integer |
参数解释: 迁移中的实例数。 取值范围: 不涉及。 |
flushing_count |
Integer |
参数解释: 清空中的实例数。 取值范围: 不涉及。 |
upgrading_count |
Integer |
参数解释: 升级中的实例数。 取值范围: 不涉及。 |
restoring_count |
Integer |
参数解释: 恢复中的实例数。 取值范围: 不涉及。 |
extending_count |
Integer |
参数解释: 扩容中的实例数。 取值范围: 不涉及。 |
creating_count |
Integer |
参数解释: 正在创建的实例数。 取值范围: 不涉及。 |
running_count |
Integer |
参数解释: 正在运行的实例数。 取值范围: 不涉及。 |
error_count |
Integer |
参数解释: 异常的实例数。 取值范围: 不涉及。 |
frozen_count |
Integer |
参数解释: 已冻结的实例数。 取值范围: 不涉及。 |
createfailed_count |
Integer |
参数解释: 创建失败的实例数。 取值范围: 不涉及。 |
restarting_count |
Integer |
参数解释: 正在重启的实例数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
paying_count |
Integer |
参数解释: 支付中的实例数。 取值范围: 不涉及。 |
freezing_count |
Integer |
参数解释: 冻结中的实例数。 取值范围: 不涉及。 |
migrating_count |
Integer |
参数解释: 迁移中的实例数。 取值范围: 不涉及。 |
flushing_count |
Integer |
参数解释: 清空中的实例数。 取值范围: 不涉及。 |
upgrading_count |
Integer |
参数解释: 升级中的实例数。 取值范围: 不涉及。 |
restoring_count |
Integer |
参数解释: 恢复中的实例数。 取值范围: 不涉及。 |
extending_count |
Integer |
参数解释: 扩容中的实例数。 取值范围: 不涉及。 |
creating_count |
Integer |
参数解释: 正在创建的实例数。 取值范围: 不涉及。 |
running_count |
Integer |
参数解释: 正在运行的实例数。 取值范围: 不涉及。 |
error_count |
Integer |
参数解释: 异常的实例数。 取值范围: 不涉及。 |
frozen_count |
Integer |
参数解释: 已冻结的实例数。 取值范围: 不涉及。 |
createfailed_count |
Integer |
参数解释: 创建失败的实例数 取值范围: 不涉及。 |
restarting_count |
Integer |
参数解释: 正在重启的实例数 取值范围: 不涉及。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/status?include_failure=true
响应示例
状态码: 200
查询实例数量统计信息成功。
{ "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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询实例数量统计信息成功。 |
400 |
非法请求。 |
500 |
内部服务错误。 |
错误码
请参见错误码。