DescribeInstanceSummary - 擷取執行個體概覽資訊 - ApsaraDB for OceanBase (Deprecated)

擷取 OceanBase 執行個體概覽資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeInstanceSummary

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100 預設值：10	10
PageNumber	integer	否	分頁查詢的頁碼。起始值：1 預設值：1	1

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果
RequestId	string	請求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceSummary	object	執行個體概覽資訊。
TotalInstancesCount	integer	執行個體總數。	3
OverLoadInstancesCount	integer	超載執行個體數量（個）。	1
ImmediatelyExpiredInstancesCount	integer	到期待釋放執行個體總數。	1
RunningInstancesCount	integer	運行中的執行個體數量。	1
InsufficientDiskInstancesCount	integer	具有容量風險的叢集總數。	2
ExpiredInstancesCount	integer	已到期的執行個體數量。	1
AlarmSummaryCount	integer	在查詢時間範圍內每條記錄的條數。	1
AnomalySQLCount	integer	anomalysql 總數量。	1
ClusterInstancesCount	integer	叢集執行個體數量	1
TenantInstancesCount	integer	租戶執行個體數量	1
TotalOmsInstancesCount	integer	資料轉送執行個體數。	1
RegionalInstanceSummaryList	array<object>	地區執行個體概要列表。
	object
Region	string	地區 ID。	cn-shanghai
TotalInstancesCount	integer	執行個體總數。	3
ImmediatelyExpiredInstancesCount	integer	即將到期執行個體數。	1
RunningInstancesCount	integer	運行中執行個體總數。	1
ExpiredInstancesCount	integer	已到期執行個體數。	1
RecentCreatedInstancesCount	integer	近期建立執行個體數。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "InstanceSummary": {
    "TotalInstancesCount": 3,
    "OverLoadInstancesCount": 1,
    "ImmediatelyExpiredInstancesCount": 1,
    "RunningInstancesCount": 1,
    "InsufficientDiskInstancesCount": 2,
    "ExpiredInstancesCount": 1,
    "AlarmSummaryCount": 1,
    "AnomalySQLCount": 1,
    "ClusterInstancesCount": 1,
    "TenantInstancesCount": 1,
    "TotalOmsInstancesCount": 1,
    "RegionalInstanceSummaryList": [
      {
        "Region": "cn-shanghai",
        "TotalInstancesCount": 3,
        "ImmediatelyExpiredInstancesCount": 1,
        "RunningInstancesCount": 1,
        "ExpiredInstancesCount": 1,
        "RecentCreatedInstancesCount": 1
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。