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 |
The policy ID. |
13 |
| Name |
string |
No |
The policy name. |
默认数据分析策略 |
| Description |
string |
No |
The policy description. |
控制数据分析模块的查询结果安全行为 |
| Workspaces |
array |
No |
A list of associated workspace IDs. |
|
|
integer |
No |
A workspace ID. |
12343 |
|
| Content |
object |
Yes |
The policy content, which is constrained by the |
|
| Controllers |
array<object> |
Yes |
A list of controllers. Note: The valid controllers depend on the selected schema. For more information, see the controller definition and the list of controllers for each schema. |
|
|
object |
No |
A controller. |
||
| Controller |
string |
No |
The controller identifier. For valid values, see the list of controllers for each schema. |
viewCount |
| DisplayName |
string |
No |
The display name. |
查询结果-单次展示记录值上限 |
| DisplayNameEn |
string |
No |
The English display name. |
Query Results - Single Display Record Limit |
| Enable |
boolean |
No |
Indicates whether the controller is enabled. |
true |
| ControllerValueType |
string |
No |
The data type of the controller's value. Valid values: |
Integer |
| UserConfigValue |
any |
No |
The user-configured value. The type of this value is determined by the |
20 |
| BasicEditionDefaultValue |
any |
No |
The default value for the Basic edition. |
10000 |
| StandardEditionDefaultValue |
any |
No |
The default value for the Standard edition. |
10000 |
| ProfessionalEditionDefaultValue |
any |
No |
The default value for the Professional edition. |
10000 |
| EnterpriseEditionDefaultValue |
any |
No |
The default value for the Enterprise edition. |
10000 |
| BasicEditionIntervalValue |
array |
No |
The value range for the Basic edition, specified as |
|
|
integer |
No |
The minimum or maximum value of the range. |
0 |
|
| StandardEditionIntervalValue |
array |
No |
The value range for the Standard edition, specified as |
|
|
integer |
No |
The minimum or maximum value of the range. |
0 |
|
| ProfessionalEditionIntervalValue |
array |
No |
The value range for the Professional edition, specified as |
|
|
integer |
No |
The minimum or maximum value of the range. |
0 |
|
| EnterpriseEditionIntervalValue |
array |
No |
The value range for the Enterprise edition, specified as |
|
|
integer |
No |
The minimum or maximum value of the range. |
0 |
|
| ClientToken |
string |
No |
A client token to ensure request idempotence. |
1AFAE64E-D1BE-432B-A9***** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Indicates the error code if the request fails. |
||
| 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.