To modify the configuration of an existing security policy, you must be both a DataWorks tenant administrator and a security administrator.
Operation description
Usage
Use this API to update a specified security policy, including its name, description, associated workspace IDs, and policy content.
You cannot modify some properties of default system policies, such as the schema name and control module.
When
ControlDwScopeis set toWorkspace, use theWorkspacesparameter to associate the policy with specific workspaces.When updating the policy content (
Content), ensure that the provided controllers (Controllers) conform to the requirements of the selected schema.The optional
ClientTokenparameter ensures request idempotence.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
integer |
Yes |
Policy ID |
13 |
| Name |
string |
No |
Policy name |
Default Data Analysis Policy |
| Description |
string |
No |
Policy description |
Controls the security behavior of query results in the Data Analysis module |
| Workspaces |
array |
No |
List of associated workspace IDs |
|
|
integer |
No |
The workspace ID. |
12343 |
|
| Content |
object |
Yes |
The policy content. The content is constrained by SecurityStrategySchema. |
|
| Controllers |
array |
Yes |
The list of controllers. Note: Valid controllers depend on the selected schema. For more information, see the controller definitions and the controller list for each schema. |
|
|
object |
No |
The list of controllers. |
||
| Controller |
string |
No |
The controller identifier. For valid values, see the controller list for each schema. |
viewCount |
| DisplayName |
string |
No |
The display name. |
Query Results - Single Display Record Limit |
| DisplayNameEn |
string |
No |
The display name in English. |
Query Results - Single Display Record Limit |
| Enable |
boolean |
No |
Specifies whether to enable this controller. |
true |
| ControllerValueType |
string |
No |
The value type of the controller (Boolean/Integer/Long/String). |
Integer |
| UserConfigValue |
any |
No |
The user-configured value. The type depends on ControllerValueType. |
20 |
| BasicEditionDefaultValue |
any |
No |
The default value for Basic Edition. |
10000 |
| StandardEditionDefaultValue |
any |
No |
The default value for Standard Edition. |
10000 |
| ProfessionalEditionDefaultValue |
any |
No |
The default value for Professional Edition. |
10000 |
| EnterpriseEditionDefaultValue |
any |
No |
The default value for Enterprise Edition. |
10000 |
| BasicEditionIntervalValue |
array |
No |
The valid value range [min, max] for Basic Edition. |
|
|
integer |
No |
The start or end value of the range. |
0 |
|
| StandardEditionIntervalValue |
array |
No |
The valid value range [min, max] for Standard Edition. |
|
|
integer |
No |
The start or end value of the range. |
0 |
|
| ProfessionalEditionIntervalValue |
array |
No |
The valid value range [min, max] for Professional Edition. |
|
|
integer |
No |
The start or end value of the range. |
0 |
|
| EnterpriseEditionIntervalValue |
array |
No |
The valid value range [min, max] for Enterprise Edition. |
|
|
integer |
No |
The start or end value of the range. |
0 |
|
| ClientToken |
string |
No |
The idempotency parameter. This parameter is used to prevent repeated operations caused by multiple API calls. |
1AFAE64E-D1BE-432B-A9***** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The error code returned when the API call fails. This parameter is not empty when an error occurs. |
||
| RequestId |
string |
The request ID. |
0bc5df3a17***903790e8e8a |
Examples
Success response
JSON format
{
"RequestId": "0bc5df3a17***903790e8e8a"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.