CreateSecurityStrategy - CreateSecurityStrategy
Creates a security control policy for specified modules and submodules. Requires DataWorks tenant administrator and security administrator permissions.
Operation description
Request
-
SchemaName: Select a schema that fits your business needs.
-
ControlModule and ControlSubModule: Specify the module and submodule for the policy, ensuring they match the selected schema.
-
ControlDwScope: Set the policy scope to either the tenant or workspace level.
-
Workspaces: If
ControlDwScopeis set toWorkspace, provide the corresponding workspace IDs. -
Content.Controllers: The controllers must match the definitions in the selected schema.
-
This operation cannot create system default policies.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
Yes |
Policy name |
Default Data Analysis policy |
| Description |
string |
No |
Policy description |
Controls the security behavior of query results in the Data Analysis module |
| SchemaName |
string |
Yes |
Schema template name |
DataQuerySecurityStrategySchema |
| ControlModule |
string |
Yes |
Control module |
DataQuery |
| ControlSubModule |
string |
No |
Control submodule |
MyCatalog |
| ControlDwScope |
string |
Yes |
Control scope (Workspace/Tenant) |
Tenant |
| Workspaces |
array |
No |
List of associated workspace IDs |
|
|
integer |
No |
Workspace ID |
1853943 |
|
| Content |
object |
Yes |
Policy content, constrained by SecurityStrategySchema. |
|
| Name |
string |
Yes |
The SecurityStrategySchema.name associated with the current policy. |
DataQuerySecurityStrategySchema |
| DisplayName |
string |
No |
The SecurityStrategySchema.displayName associated with the current policy. |
Data Analysis |
| DisplayNameEn |
string |
No |
The SecurityStrategySchema.displayNameEn associated with the current policy. |
Data Analysis |
| ControlModule |
string |
Yes |
The control module. Maps to SecurityStrategySchema.controlModule for this policy. |
DataStudio |
| ControlSubModule |
string |
No |
The control submodule. Maps to SecurityStrategySchema.controlSubModule for this policy. |
MyCatalog |
| ControlDwScope |
string |
No |
The control scope. The SecurityStrategySchema.name associated with the current policy. |
Tenant |
| SystemPolicyName |
string |
No |
The SecurityStrategySchema.name associated with the current policy. |
SYSTEM_GENERATE_DEFAULT_DATA_QUERY |
| SystemPolicyDisplayName |
string |
No |
The SecurityStrategySchema.name associated with the current policy. |
Default system generate data query policy |
| Controllers |
array |
No |
List of controllers. Note: Valid controllers depend on the selected schema. Refer to the controller definitions and the controller list for each schema. |
|
|
object |
No |
Controller |
||
| Controller |
string |
No |
The controller identifier. For valid values, see the controller list for each schema. |
viewCount |
| DisplayName |
string |
No |
Display name |
Query Results - Single Display Record Limit |
| DisplayNameEn |
string |
No |
English display name |
Query Results - Single Display Record Limit |
| Enable |
boolean |
No |
Whether to enable the controller. |
true |
| ControllerValueType |
string |
No |
The value type (Boolean/Integer/Long/String). |
Integer |
| UserConfigValue |
any |
No |
The user-configured value. The type depends on |
10 |
| BasicEditionDefaultValue |
any |
No |
Default value for Basic Edition |
0 |
| StandardEditionDefaultValue |
any |
No |
Default value for Standard Edition |
100000 |
| ProfessionalEditionDefaultValue |
any |
No |
Default value for Professional Edition |
200000 |
| EnterpriseEditionDefaultValue |
any |
No |
Default value for Enterprise Edition |
500000 |
| BasicEditionIntervalValue |
array |
No |
Valid value range [min, max] for Basic Edition |
|
|
integer |
No |
Start and end values of the range |
0 |
|
| StandardEditionIntervalValue |
array |
No |
Valid value range [min, max] for Standard Edition |
|
|
integer |
No |
Start and end values of the range |
100000 |
|
| ProfessionalEditionIntervalValue |
array |
No |
Valid value range [min, max] for Professional Edition |
|
|
integer |
No |
Start and end values of the range |
200000 |
|
| EnterpriseEditionIntervalValue |
array |
No |
Valid value range [min, max] for Enterprise Edition |
|
|
integer |
No |
Start and end values of the range |
500000 |
|
| ClientToken |
string |
No |
Idempotency token. Prevents duplicate operations from repeated calls. |
ABFUOEUOTRTRJKE |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
0bc5df3a17****903790e8e8a |
| Id |
integer |
The security policy ID. |
12345 |
Examples
Success response
JSON format
{
"RequestId": "0bc5df3a17****903790e8e8a",
"Id": 12345
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.