Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying Instance Statistics
Updated on 2025-08-18 GMT+08:00
View PDF

Querying Instance Statistics

Function

This API is used to query instance statistics. Before calling this API:

URI

GET https://{Endpoint}/v3/instances-statistics

Request Parameters

None

Response Parameters

Table 1 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of instances.

instances_statistics

Array of Table 2 objects

Instance statistics.
Table 2 instances_statistics

Parameter

Type

Description

status

String

Instance status.

count

Integer

Number of instances.

Example Request

Querying instance statistics

GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/instances-statistics

Example Response

Instance statistics queried.

{ 
  "total_count" : "10", 
  "instances_statistics" : [ { 
    "status" : "normal", 
    "count" : 1 
  }, { 
    "status" : "abnormal", 
    "count" : 2 
  }, { 
    "status" : "creating", 
    "count" : 3 
  }, { 
    "status" : "createfail", 
    "count" : 4 
  } ] 
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management