查詢AnalyticDB PostgreSQL版實例中的節點信息。
接口說明
使用說明
本接口用于查看存儲彈性模式和 Serverless 版本的 AnalyticDB PostgreSQL 版實例的 Master 節點或 Segment 節點信息。
QPS 限制
本接口的單用戶 QPS 限制默認為 1000 次/秒。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。
本文檔中的 QPS 僅為默認參考值,準確信息請參見 API 速率配額列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
gpdb:DescribeDBClusterNode | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 說明
您可以調用 DescribeDBInstances 接口查看目標地域下所有的 AnalyticDB PostgreSQL 實例的詳情,包括實例 ID。
| gp-bp*************** |
NodeType | string | 否 | 節點類型。取值說明:
說明
如果不傳入該參數,則返回所有節點的監控信息。
| master |
返回參數
示例
正常返回示例
JSON
格式
{
"Nodes": [
{
"Name": "master-10*******"
}
],
"RequestId": "87E44B48-B306-4AD3-A63B-C8**********",
"DBClusterId": "gp-bp***************"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史