DescribeDBInstanceConfig - 查询实例配置参数-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

您可以在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}"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。