調用DescribeDBInstanceConfig接口獲取實例配置參數。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeDBInstanceConfig

系統規定參數。取值：DescribeDBInstanceConfig。

RegionId String 是 cn-hangzhou

實例所屬地域的ID。
DBInstanceName String 是 pxc-*********

實例ID。
ConfigName String 是 htap

配置標識， 默認：htap。

返回數據

名稱 類型 示例值 描述
RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

請求ID。
Data Object

數據結構體。
ConfigName String htap

配置Key。
DbInstanceName String pxc-sprcym7g7w****

實例ID。
ConfigValue String {\"attendHtapList\":[\"pxc-hzruyzes08****\"],\"autoAttendHtap\":\"true\",\"delayExecutionStrategy\":1,\"enableConsistentReplicaRead\":true,\"enableHtap\":\"true\",\"masterReadWeight\":100,\"storageDelayThreshold\":3}

配置項，說明如下：

  • attendHtapList：開啟Htap的實例列表。
  • autoAttendHtap：是否自動把新建的只讀實例加入到HTAP列表里。
  • delayExecutionStrategy：當只讀延遲到達storageDelayThreshold設定的值時，將只讀流量切回主實例。默認值為1，取值為0或1。
  • enableConsistentReplicaRead：是否開啟一致性讀。
  • storageDelayThreshold：只讀實例延遲閾值，默認3s，范圍為：0~3600*24。
  • enableHtap：是否開始Htap。
  • masterReadWeight：主節點讀權重，設置100表示100%的流量打到主節點，范圍為：0~100。

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeDBInstanceConfig
&RegionId=cn-hangzhou
&DBInstanceName=pxc-*********
&ConfigName=htap
&公共請求參數

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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}"
  }
}

錯誤碼

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