調(diào)用DescribeParameters查詢參數(shù)設置中的所有參數(shù)。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeParameters |
系統(tǒng)規(guī)定參數(shù)。取值：DescribeParameters。 |
| ClusterId | String | 是 | cds-j6c1zij8****994s |
集群ID。 |
| PageNumber | Integer | 否 | 1 |
列表的頁碼 取值：大于0且不超過Integer的最大值。 默認值：1。 |
| PageSize | Integer | 否 | 10 |
分頁查詢時設置的每頁行數(shù)，默認值10。 |
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| PageNumber | Integer | 1 |
列表的頁碼。 取值：大于0且不超過Integer的最大值。 默認值：1。 |
| PageSize | Integer | 10 |
分頁查詢時設置的每頁行數(shù)。 |
| Parameters | Array |
參數(shù)列表。 |
|
| Parameter | |||
| AllowedValues | String | R[1000, 60000] |
可修改參數(shù)值。 |
| DataType | String | INT |
參數(shù)單位。 |
| DefaultValue | String | 1000 |
參數(shù)默認值。 |
| Description | String | How long the coordinator should wait for seq or index scans to complete. |
參數(shù)描述。 |
| Name | String | range_request_timeout_in_ms |
參數(shù)名。 |
| Value | String | 1000 |
運行參數(shù)值。 |
| RequestId | String | 863163EC-69DA-41B3-AB78-37C123114307 |
請求ID。 |
| TotalCount | Long | 9 |
總記錄數(shù)。 |
示例
請求示例
http(s)://[Endpoint]/?Action=DescribeParameters
&ClusterId=cds-j6c1zij8****994s
&<公共請求參數(shù)>正常返回示例
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"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。