獲取 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 |
返回參數
示例
正常返回示例
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
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-29 | OpenAPI 返回結構發生變更 | 查看變更詳情 |