全部產品
Search
文件中心

PolarDB:DescribeDBInstanceConfig

更新時間:Sep 10, 2026

呼叫 DescribeDBInstanceConfig 介面取得執行個體設定參數。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeDBInstanceConfig

none

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

執行個體所屬地域的 ID。

cn-hangzhou

DBInstanceName

string

是

執行個體 ID。

pxc-*********

ConfigName

string

是

設定識別碼,預設:htap。

htap

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

C458B1E8-1683-3645-B154-6BA32080EEA

Data

object

資料結構體。

ConfigName

string

設定 Key。

htap

DbInstanceName

string

執行個體 ID。

pxc-sprcym7g7w****

ConfigValue

string

設定項目,說明如下:

  • attendHtapList:啟用 Htap 的執行個體清單。

  • autoAttendHtap:是否自動將新建的唯讀執行個體加入到 HTAP 清單中。

  • delayExecutionStrategy:當唯讀延遲到達 storageDelayThreshold 設定的值時,將唯讀流量切回主執行個體。預設值為 1,取值為 0 或 1。

  • enableConsistentReplicaRead:是否啟用一致性讀取。

  • storageDelayThreshold:唯讀執行個體延遲閾值,預設 3s,範圍為:0~3600*24。

  • enableHtap:是否啟用 Htap。

  • masterReadWeight:主節點讀取權重,設定 100 表示 100% 的流量導向主節點,範圍為:0~100。

{\"attendHtapList\":[\"pxc-hzruyzes08****\"],\"autoAttendHtap\":\"true\",\"delayExecutionStrategy\":1,\"enableConsistentReplicaRead\":true,\"enableHtap\":\"true\",\"masterReadWeight\":100,\"storageDelayThreshold\":3}

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data": {
    "ConfigName": "htap",
    "DbInstanceName": "pxc-sprcym7g7w****",
    "ConfigValue": "{\\\"attendHtapList\\\":[\\\"pxc-hzruyzes08****\\\"],\\\"autoAttendHtap\\\":\\\"true\\\",\\\"delayExecutionStrategy\\\":1,\\\"enableConsistentReplicaRead\\\":true,\\\"enableHtap\\\":\\\"true\\\",\\\"masterReadWeight\\\":100,\\\"storageDelayThreshold\\\":3}"
  }
}

錯誤碼

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

變更歷史

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