ListSecurityStrategies - ListSecurityStrategies-DataWorks(DataWorks)-阿里云帮助中心

Retrieves a paginated list of security policies. This operation requires DataWorks tenant administrator or security administrator permissions.

Operation description

Request

Retrieves a paginated list of configured security policies.
Use ControlModule and ControlSubModule to filter policies by module or submodule.
PageNum and PageSize control pagination: page number (default: 1) and entries per page (default: 20).
Use the MaxResults and NextToken private parameters for advanced pagination.

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
ControlModule	string	No	Control module	DataQuery
ControlSubModule	string	No	Control submodule	MyCatalog
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0bc5df3a17****903790e8e8a
PagingInfo	object	The pagination information.
PageNumber	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 20.	10
TotalCount	integer	The total number of entries.	12
SecurityStrategies	array	The list of security policies.
	array	Security policy.
Id	string	The policy ID.	12345
Name	string	The policy name.	Default Data Analysis policy
Description	string	The policy description.	Controls the security behavior of query results in the Data Analysis module.
SchemaName	string	The schema template name. Valid values: DataStudioMyCatalogSecurityStrategySchema : DataStudioMyCatalogSecurityStrategySchema DataQuerySecurityStrategySchema : DataQuerySecurityStrategySchema DataStudioSecurityStrategySchema : DataStudioSecurityStrategySchema	DataQuerySecurityStrategySchema
ControlModule	string	Control module	DataQuery
ControlSubModule	string	Control submodule	MyCatalog
ControlDwScope	string	Control scope (Workspace/Tenant)	Tenant
Workspaces	array	The list of associated workspace IDs
	integer	The workspace ID.	343434
Enabled	boolean	Indicates whether the policy is enabled	false
OriginPolicyId	integer	The ID of the source system default policy	12
Creator	string	The user ID of the creator	203322746501002787
Updater	string	The user ID of the last updater	203322746501002787
CreateTime	string	The time when the policy was created.	2026-05-25T20:46:19
UpdateTime	string	The time when the policy was last updated.	2026-05-25T20:46:19
Content	object	The policy content, constrained by SecurityStrategySchema.
Name	string	The SecurityStrategySchema.name associated with the current policy.	DataQuerySecurityStrategySchema
DisplayName	string	The SecurityStrategySchema.displayName associated with the current policy.	Data Analysis
DisplayNameEn	string	The SecurityStrategySchema.displayNameEn associated with the current policy.	Data Query
ControlModule	string	The SecurityStrategySchema.controlModule associated with the current policy.	DataQuery
ControlSubModule	string	The SecurityStrategySchema.controlSubModule associated with the current policy.	MyCatalog
ControlDwScope	string	Control scope Valid values: Tenant : Tenant Workspace : Workspace	Tenant
SystemPolicyName	string	The system policy name. If not empty, the system automatically creates a default policy.	SYSTEM_GENERATE_DEFAULT_DATA_QUERY
SystemPolicyDisplayName	string	The display name of the system policy.	Default system generate data query policy
Controllers	array	The control items. Valid items depend on the selected schema. For details, see the Controller definition and control item list for each schema.
	object	Control item.
Controller	string	The control item identifier. For valid values, see the control item list for each schema.	viewCount
DisplayName	string	The display name.	Query results - Single display record limit
DisplayNameEn	string	The English display name	Query Results - Single Display Record Limit
Enable	boolean	Indicates whether this control item is enabled
ControllerValueType	string	The value type (Boolean/Integer/Long/String)	Integer
UserConfigValue	any	The user-configured value. The type depends on ControllerValueType.	20
BasicEditionDefaultValue	any	The default value for Basic Edition	10000
StandardEditionDefaultValue	any	The default value for Standard Edition	10000
ProfessionalEditionDefaultValue	any	The default value for Professional Edition.	10000
EnterpriseEditionDefaultValue	any	The default value for Enterprise Edition.	10000
BasicEditionIntervalValue	array	The valid value range [min, max] for Basic Edition.
	integer	The boundary value of the range.	0
StandardEditionIntervalValue	array	The valid value range [min, max] for Standard Edition.
	integer	The boundary value of the range.	0
ProfessionalEditionIntervalValue	array	The valid value range [min, max] for Professional Edition.
	integer	The boundary value of the range.	0
EnterpriseEditionIntervalValue	array	The valid value range [min, max] for Enterprise Edition.
	integer	The boundary value of the range.	0

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17****903790e8e8a",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 12,
    "SecurityStrategies": [
      {
        "Id": "12345",
        "Name": "Default Data Analysis policy",
        "Description": "Controls the security behavior of query results in the Data Analysis module",
        "SchemaName": "DataQuerySecurityStrategySchema",
        "ControlModule": "DataQuery",
        "ControlSubModule": "MyCatalog",
        "ControlDwScope": "Tenant",
        "Workspaces": [
          343434
        ],
        "Enabled": false,
        "OriginPolicyId": 12,
        "Creator": "203322746501002787",
        "Updater": "203322746501002787",
        "CreateTime": "2026-05-25T20:46:19",
        "UpdateTime": "2026-05-25T20:46:19",
        "Content": {
          "Name": "DataQuerySecurityStrategySchema",
          "DisplayName": "Data Analysis",
          "DisplayNameEn": "Data Query",
          "ControlModule": "DataQuery",
          "ControlSubModule": "MyCatalog",
          "ControlDwScope": "Tenant",
          "SystemPolicyName": "SYSTEM_GENERATE_DEFAULT_DATA_QUERY",
          "SystemPolicyDisplayName": "Default system generate data query policy",
          "Controllers": [
            {
              "Controller": "viewCount",
              "DisplayName": "Query Results - Single Display Record Limit",
              "DisplayNameEn": "Query Results - Single Display Record Limit",
              "Enable": true,
              "ControllerValueType": "Integer",
              "UserConfigValue": "20",
              "BasicEditionDefaultValue": "10000",
              "StandardEditionDefaultValue": "10000",
              "ProfessionalEditionDefaultValue": "10000",
              "EnterpriseEditionDefaultValue": "10000",
              "BasicEditionIntervalValue": [
                0
              ],
              "StandardEditionIntervalValue": [
                0
              ],
              "ProfessionalEditionIntervalValue": [
                0
              ],
              "EnterpriseEditionIntervalValue": [
                0
              ]
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.