调用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}"
  }
}

错误码

访问错误中心查看更多错误码。