You can call this operation to query all parameters in the parameter settings.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeParameters |
The operation that you want to perform. Set the value to DescribeParameters. |
ClusterId | String | Yes | cds-j6c1zij8****994s |
The ID of the cluster. |
PageNumber | Integer | No | 1 |
The number of the page to return. Valid values: any positive integer. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageNumber | Integer | 1 |
The page number of the returned page. Valid values: any positive integer. Default value: 1. |
PageSize | Integer | 10 |
The number of entries returned per page. |
Parameters | Array |
The list of parameters. |
|
Parameter | |||
AllowedValues | String | R[1000, 60000] |
The range of the values. |
DataType | String | INT |
The type of the parameter. |
DefaultValue | String | 1000 |
The default value of the parameter. |
Description | String | How long the coordinator should wait for seq or index scans to complete. |
The description of the parameter. |
Parameter | String | range_request_timeout_in_ms |
The name of the parameter. |
Value | String | 1000 |
The value that is being used. |
RequestId | String | 863163EC-69DA-41B3-AB78-37C123114307 |
The ID of the request. |
TotalCount | Long | 9 |
The total number of entries returned. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeParameters
&ClusterId=cds-j6c1zij8****994s
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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"
}
Error codes
For a list of error codes, visit the API Error Center.