DescribeDrdsParams - PolarDB-X 1.0| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDrdsParams	The operation that you want to perform. Set the value to DescribeDrdsParams.
DrdsInstanceId	String	Yes	DescribeDrdsParams	DRDS instance ID
ParamLevel	String	Yes	INSTANCE	Parameter level. Valid values: INSTANCE and DB.
DbName	String	No	drds_test	DRDS database name
RegionId	String	No	cn-hangzhou	The ID of the region where the returned SLB instance is located.

Response parameters


Prameter	Type	Sample response	Description
List			Parameters
DbName	String	drds_test	DRDS database name
NeedRestart	Boolean	true	Need to be restarted or not
ParamDefaultValue	String	Default value: 1000.	Default
ParamDesc	String	Slow SQL query threshold (unit: ms)	Description
ParamEnglishName	String	SLOW_SQL_TIME	Parameter name
ParamLevel	String	INSTANCE	Parameter level
ParamName	String	Slow SQL query threshold	Parameter
ParamRanges	String	[1000-900000]	Parameter value range
ParamType	String	CONFIG	Parameters Type
ParamValue	String	Default value: 1000.	Description
ParamVariableName	String	slowSqlTime	Parameter variable
RequestId	String	2F7F8080-9132-4279-85D0-B7E5C4******	The ID of the request.
Success	Boolean	true	Indicates whether the call is successful.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeDrdsParams
&DrdsInstanceId=DescribeDrdsParams
&ParamLevel=INSTANCE
& <Common request parameters>

Sample success responses

XML format

<DescribeDrdsParams>
	  <RequestId>29D7422F-24DD-42D8-A04E-EBCE4B******</RequestId>
	  <List>
		    <ParamLevel>INSTANCE</ParamLevel>
		    <ParamRanges>[1000-900000]</ParamRanges>
		    <ParamVariableName>slowSqlTime</ParamVariableName>
		    <ParamEnglishName>SLOW_SQL_TIME</ParamEnglishName>
		    <NeedRestart>false</NeedRestart>
		    <ParamValue>1000</ParamValue>
		    <ParamDefaultValue>1000</ParamDefaultValue>
		    <DbName></DbName>
		    <UserVisible>true</UserVisible>
		    <ParamName>SLOW_SQL_TIME</ParamName>
		    <ParamType>CONFIG</ParamType>
		    <ParamDesc>The slow SQL query threshold (unit: ms).</ParamDesc>
	  </List>
	  <List>
		    <ParamLevel>INSTANCE</ParamLevel>
		    <ParamRanges>[3600000-86400000]</ParamRanges>
		    <ParamVariableName>idleTimeout</ParamVariableName>
		    <ParamEnglishName>LOGIC_IDLE_TIMEOUT</ParamEnglishName>
		    <NeedRestart>false</NeedRestart>
		    <ParamValue>28800000</ParamValue>
		    <ParamDefaultValue>28800000</ParamDefaultValue>
		    <DbName></DbName>
		    <UserVisible>true</UserVisible>
		    <ParamName>LOGIC_IDLE_TIMEOUT</ParamName>
		    <ParamType>CONFIG</ParamType>
		    <ParamDesc>The logical timeout period of the idle connection between users and DRDS (unit: ms).</ParamDesc>
	  </List>
	  <List>
		    <ParamLevel>INSTANCE</ParamLevel>
		    <ParamRanges>[4194304-33554432]</ParamRanges>
		    <ParamVariableName>maxAllowedPacket</ParamVariableName>
		    <ParamEnglishName>MAX_ALLOWED_PACKET</ParamEnglishName>
		    <NeedRestart>false</NeedRestart>
		    <ParamValue>16777216</ParamValue>
		    <ParamDefaultValue>16777216</ParamDefaultValue>
		    <DbName></DbName>
		    <UserVisible>true</UserVisible>
		    <ParamName>MAX_ALLOWED_PACKET</ParamName>
		    <ParamType>CONFIG</ParamType>
		    <ParamDesc>The maximum network packet for the interaction between users and the DRDS (unit: byte).</ParamDesc>
	  </List>
	  <List>
		    <ParamLevel>INSTANCE</ParamLevel>
		    <ParamRanges>[1073741824-6442450944]</ParamRanges>
		    <ParamVariableName>GLOBAL_MEMORY_LIMIT</ParamVariableName>
		    <ParamEnglishName>GLOBAL_MEMORY_LIMIT</ParamEnglishName>
		    <NeedRestart>false</NeedRestart>
		    <ParamValue>2147483648</ParamValue>
		    <ParamDefaultValue>2147483648</ParamDefaultValue>
		    <DbName></DbName>
		    <UserVisible>true</UserVisible>
		    <ParamName>GLOBAL_MEMORY_LIMIT</ParamName>
		    <ParamType>CONFIG</ParamType>
		    <ParamDesc>The maximum size of the memory pool for a read-only instance. If the memory usage on an instance exceeds the value, an error is reported and the query ends.</ParamDesc>
	  </List>
	  <Success>true</Success>
</DescribeDrdsParams>

JSON format

{
	"RequestId":"29D7422F-24DD-42D8-A04E-EBCE4B******",
	"Success":true,
	"List":[
		{
			"NeedRestart":false,
			"ParamEnglishName":"SLOW_SQL_TIME",
			"ParamDesc":"The slow SQL query threshold (unit: ms).",
			"ParamName":"SLOW_SQL_TIME",
			"DbName":"",
			"ParamValue":"1000",
			"ParamType":"CONFIG",
			"ParamLevel":"INSTANCE",
			"UserVisible":true,
			"ParamDefaultValue":"1000",
			"ParamVariableName":"slowSqlTime",
			"ParamRanges":"[1000-900000]"
		},
		{
			"NeedRestart":false,
			"ParamEnglishName":"LOGIC_IDLE_TIMEOUT",
			"ParamDesc":"The logical timeout period of the idle connection between users and DRDS (unit: ms).",
			"ParamName":"LOGIC_IDLE_TIMEOUT",
			"DbName":"",
			"ParamValue":"28800000",
			"ParamType":"CONFIG",
			"ParamLevel":"INSTANCE",
			"UserVisible":true,
			"ParamDefaultValue":"28800000",
			"ParamVariableName":"idleTimeout",
			"ParamRanges":"[3600000-86400000]"
		},
		{
			"NeedRestart":false,
			"ParamEnglishName":"MAX_ALLOWED_PACKET",
			"ParamDesc":"The maximum network packet for the interaction between users and the DRDS (unit: byte).",
			"ParamName":"MAX_ALLOWED_PACKET",
			"DbName":"",
			"ParamValue":"16777216",
			"ParamType":"CONFIG",
			"ParamLevel":"INSTANCE",
			"UserVisible":true,
			"ParamDefaultValue":"16777216",
			"ParamVariableName":"maxAllowedPacket",
			"ParamRanges":"[4194304-33554432]"
		},
		{
			"NeedRestart":false,
			"ParamEnglishName":"GLOBAL_MEMORY_LIMIT",
			"ParamDesc":"The maximum size of the memory pool for a read-only instance. If the memory usage on an instance exceeds the value, an error is reported and the query ends.",
			"ParamName":"GLOBAL_MEMORY_LIMIT",
			"DbName":"",
			"ParamValue":"2147483648",
			"ParamType":"CONFIG",
			"ParamLevel":"INSTANCE",
			"UserVisible":true,
			"ParamDefaultValue":"2147483648",
			"ParamVariableName":"GLOBAL_MEMORY_LIMIT",
			"ParamRanges":"[1073741824-6442450944]"
		}
	]
}

Error codes

For a list of error codes, visit the API Error Center.