Skip to main content

Bind or Unbind Rule Set Resources

Use this API to bind a SQL rule set to specified resources or remove an existing rule set binding. Supported resource types include environments, data sources, and database groups.

Request URL: /openapi/v1/ruleSet/bind

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
idStringNoRule set ID. Pass null or an empty string to remove the rule set binding from the resources.rs-default-dev
resourceTypeStringYesResource type. Valid values: env, datasource, group.env
resourceIdListArrayYesResource ID list. At least one resource ID is required.["env-dev"]

Request Example

{
"id": "rs-default-dev",
"resourceType": "env",
"resourceIdList": ["env-dev"]
}

Unbind Request Example

{
"id": "",
"resourceType": "env",
"resourceIdList": ["env-dev"]
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID for troubleshooting and tracing.Oz7n0MHW-bhhilEWnheja2MJdcju2NFZ
errorCodeStringError code returned when the call fails.None
messageStringError message returned when the call fails.None

Successful Invocation Example

{
"success": true,
"requestId": "Oz7n0MHW-bhhilEWnheja2MJdcju2NFZ"
}

Result

A successful response confirms that the binding change was saved. Pass a rule set ID to bind resources, or pass null or an empty string for id to remove the rule set binding.