All Products
Search
Document Center

DataWorks:CreateSecurityStrategy

Last Updated:Jun 09, 2026

Creates a new security control policy to configure various modules and submodules. Requires both 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 ControlDwScope is set to Workspace, 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

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Name

string

Yes

Strategy name

默认数据分析策略

Description

string

No

Strategy description

控制数据分析模块的查询结果安全行为

SchemaName

string

Yes

Schema template name

DataQuerySecurityStrategySchema

ControlModule

string

Yes

Control module

DataQuery

ControlSubModule

string

No

Control submodule

MyCatalog

ControlDwScope

string

Yes

The control scope. Valid values: Workspace and Tenant.

Tenant

Workspaces

array

No

A list of associated workspace IDs.

integer

No

The workspace ID.

1853943

Content

object

Yes

The content of the strategy. This value is constrained by the SecurityStrategySchema.

Name

string

Yes

The name property of the SecurityStrategySchema associated with the current strategy.

DataQuerySecurityStrategySchema

DisplayName

string

No

The displayName property of the SecurityStrategySchema associated with the current strategy.

数据分析

DisplayNameEn

string

No

The displayNameEn property of the SecurityStrategySchema associated with the current strategy.

Data Analysis

ControlModule

string

Yes

The control module. This corresponds to the controlModule property of the SecurityStrategySchema associated with the current strategy.

DataStudio

ControlSubModule

string

No

The control submodule. This corresponds to the controlSubModule property of the SecurityStrategySchema associated with the current strategy.

MyCatalog

ControlDwScope

string

No

The control scope. This corresponds to the controlDwScope property of the SecurityStrategySchema associated with the current strategy.

Tenant

SystemPolicyName

string

No

The systemPolicyName property of the SecurityStrategySchema associated with the current strategy.

SYSTEM_GENERATE_DEFAULT_DATA_QUERY

SystemPolicyDisplayName

string

No

The systemPolicyDisplayName property of the SecurityStrategySchema associated with the current strategy.

Default system generate data query policy

Controllers

array<object>

No

A list of controllers.

Note: Valid controllers depend on the selected schema. For more information, see the controller definitions 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

Specifies whether to enable this controller.

true

ControllerValueType

string

No

The value type. Valid values: Boolean, Integer, Long, and String.

Integer

UserConfigValue

any

No

The user-configured value. The type of this value depends on the ControllerValueType parameter.

10

BasicEditionDefaultValue

any

No

The default value for Basic Edition.

0

StandardEditionDefaultValue

any

No

The default value for Standard Edition.

100000

ProfessionalEditionDefaultValue

any

No

The default value for Professional Edition.

200000

EnterpriseEditionDefaultValue

any

No

The default value for Enterprise Edition.

500000

BasicEditionIntervalValue

array

No

The valid value interval for Basic Edition, in the format [min, max].

integer

No

An interval boundary value.

0

StandardEditionIntervalValue

array

No

The valid value interval for Standard Edition, in the format [min, max].

integer

No

An interval boundary value.

100000

ProfessionalEditionIntervalValue

array

No

The valid value interval for Professional Edition, in the format [min, max].

integer

No

An interval boundary value.

200000

EnterpriseEditionIntervalValue

array

No

The valid value interval for Enterprise Edition, in the format [min, max].

integer

No

An interval boundary value.

500000

ClientToken

string

No

A client-generated token that ensures request idempotency, preventing duplicate operations if you retry the request.

ABFUOEUOTRTRJKE

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

0bc5df3a17****903790e8e8a

Id

integer

The security strategy 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.