调用DescribeParameters查询参数设置中的所有参数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeParameters

系统规定参数。取值:DescribeParameters。

ClusterId String cds-j6c1zij8****994s

集群ID。

PageNumber Integer 1

列表的页码

取值:大于0且不超过Integer的最大值。

默认值:1。

PageSize Integer 10

分页查询时设置的每页行数,默认值10。

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

列表的页码。

取值:大于0且不超过Integer的最大值。

默认值:1。

PageSize Integer 10

分页查询时设置的每页行数。

Parameters Array

参数列表。

Parameter
AllowedValues String R[1000, 60000]

可修改参数值。

DataType String INT

参数单位。

DefaultValue String 1000

参数默认值。

Description String How long the coordinator should wait for seq or index scans to complete.

参数描述。

Name String range_request_timeout_in_ms

参数名。

Value String 1000

运行参数值。

RequestId String 863163EC-69DA-41B3-AB78-37C123114307

请求ID。

TotalCount Long 9

总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeParameters
&ClusterId=cds-j6c1zij8****994s
&<公共请求参数>

正常返回示例

XML 格式

<DescribeParametersResponse>
  <Parameters>
        <Parameter>
              <Name>cas_contention_timeout_in_ms</Name>
              <Description>How long a coordinator should continue to retry a CAS operation that contends with other proposals for the same row.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>1000</Value>
              <DataType>INT</DataType>
              <DefaultValue>1000</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>counter_write_request_timeout_in_ms</Name>
              <Description>How long the coordinator should wait for counter writes to complete.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>5000</Value>
              <DataType>INT</DataType>
              <DefaultValue>5000</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>enable_materialized_views</Name>
              <Description>Enables materialized view creation on this node.</Description>
              <AllowedValues>G[true|false]</AllowedValues>
              <Value>true</Value>
              <DataType>STR</DataType>
              <DefaultValue>true</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>enable_sasi_indexes</Name>
              <Description>Enables SASI index creation on this node.</Description>
              <AllowedValues>G[true|false]</AllowedValues>
              <Value>true</Value>
              <DataType>STR</DataType>
              <DefaultValue>true</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>range_request_timeout_in_ms</Name>
              <Description>How long the coordinator should wait for seq or index scans to complete.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>10000</Value>
              <DataType>INT</DataType>
              <DefaultValue>10000</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>read_request_timeout_in_ms</Name>
              <Description>How long the coordinator should wait for read operations to complete.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>5000</Value>
              <DataType>INT</DataType>
              <DefaultValue>5000</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>request_timeout_in_ms</Name>
              <Description>The default timeout for other, miscellaneous operations.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>10000</Value>
              <DataType>INT</DataType>
              <DefaultValue>10000</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>truncate_request_timeout_in_ms</Name>
              <Description>How long the coordinator should wait for truncates to complete.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>60000</Value>
              <DataType>INT</DataType>
              <DefaultValue>60000</DefaultValue>
        </Parameter>
        <Parameter>
              <Name>write_request_timeout_in_ms</Name>
              <Description>How long the coordinator should wait for writes to complete.</Description>
              <AllowedValues>R[1000, 60000]</AllowedValues>
              <Value>2000</Value>
              <DataType>INT</DataType>
              <DefaultValue>2000</DefaultValue>
        </Parameter>
  </Parameters>
  <PageNumber>1</PageNumber>
  <TotalCount>9</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>863163EC-69DA-41B3-AB78-37C123114307</RequestId>
</DescribeParametersResponse>

JSON 格式

{
  "Parameters": {
    "Parameter": [
      {
        "Name": "cas_contention_timeout_in_ms",
        "Description": "How long a coordinator should continue to retry a CAS operation that contends with other proposals for the same row.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "1000",
        "DataType": "INT",
        "DefaultValue": "1000"
      },
      {
        "Name": "counter_write_request_timeout_in_ms",
        "Description": "How long the coordinator should wait for counter writes to complete.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "5000",
        "DataType": "INT",
        "DefaultValue": "5000"
      },
      {
        "Name": "enable_materialized_views",
        "Description": "Enables materialized view creation on this node.",
        "AllowedValues": "G[true|false]",
        "Value": "true",
        "DataType": "STR",
        "DefaultValue": "true"
      },
      {
        "Name": "enable_sasi_indexes",
        "Description": "Enables SASI index creation on this node.",
        "AllowedValues": "G[true|false]",
        "Value": "true",
        "DataType": "STR",
        "DefaultValue": "true"
      },
      {
        "Name": "range_request_timeout_in_ms",
        "Description": "How long the coordinator should wait for seq or index scans to complete.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "10000",
        "DataType": "INT",
        "DefaultValue": "10000"
      },
      {
        "Name": "read_request_timeout_in_ms",
        "Description": "How long the coordinator should wait for read operations to complete.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "5000",
        "DataType": "INT",
        "DefaultValue": "5000"
      },
      {
        "Name": "request_timeout_in_ms",
        "Description": "The default timeout for other, miscellaneous operations.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "10000",
        "DataType": "INT",
        "DefaultValue": "10000"
      },
      {
        "Name": "truncate_request_timeout_in_ms",
        "Description": "How long the coordinator should wait for truncates to complete.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "60000",
        "DataType": "INT",
        "DefaultValue": "60000"
      },
      {
        "Name": "write_request_timeout_in_ms",
        "Description": "How long the coordinator should wait for writes to complete.",
        "AllowedValues": "R[1000, 60000]",
        "Value": "2000",
        "DataType": "INT",
        "DefaultValue": "2000"
      }
    ]
  },
  "PageNumber": 1,
  "TotalCount": 9,
  "PageSize": 10,
  "RequestId": "863163EC-69DA-41B3-AB78-37C123114307"
}

错误码

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