Configures parameters for a PolarDB-X 1.0 instance.

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
RegionId String No cn-hangzhou

The ID of the region in which the PolarDB-X 1.0 instance is located.

DrdsInstanceId String Yes drdsjiii1b49****

The ID of the PolarDB-X 1.0 instance for which you want to configure parameters.

ParamLevel String Yes DB

The resource for which you want to configure parameters. Valid values:

  • INSTANCE: Configure parameters for the instance.
  • DB: Configure parameters for the databases of the instance.
Action String Yes SetupDrdsParams

The operation that you want to perform. Set the value to SetupDrdsParams.

Data.N.DbName String No test_db

The name of the parameter that you want to configure for a database.

Data.N.ParamType String No ATOM

The type of the parameter that you want to configure. Valid values:

  • ATOM: the configuration item in the layer-3 data source.
  • CONFIG: the configuration item in ConfigServer.
  • DIAMOND: the configuration item in Diamond.
Data.N.ParamValue String No true

The value of parameter that you want to configure.

Data.N.ParamVariableName String No FORBID_EXECUTE_DML_ALL

The name of the parameter that you want to configure.

Data.N.ParamRanges String No [true|false]

The valid values of the parameter.

Response parameters

Parameter Type Example Description
Data Boolean true

The returned results.

RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&DrdsInstanceId=drdsjiii1b49****
&ParamLevel=DB
&Action=SetupDrdsParams
&Data=[{"DbName":"test_db","ParamType":"ATOM","ParamValue":"true","ParamVariableName":"FORBID_EXECUTE_DML_ALL","ParamRanges":"[true|false]"}]
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<SetupDrdsParamsResponse>
    <Data>true</Data>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
    <Success>true</Success>
</SetupDrdsParamsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : true,
  "RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Success" : true
}

Error codes

HttpCode Error code Error message Description
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred and the request failed.

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