ListSecurityStrategies-阿里云帮助中心

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

Operation description

Request

This API retrieves a paginated list of configured security policies.
The ControlModule and ControlSubModule parameters filter policies by a specific module or submodule.
The PageNum and PageSize parameters control pagination. PageNum specifies the page number to retrieve (default: 1), and PageSize specifies the number of policies to return 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	The control module.	DataQuery
ControlSubModule	string	No	The control submodule.	MyCatalog
PageNumber	integer	No	The page number. Starts from 1. Default: 1.	1
PageSize	integer	No	The number of entries per page. Default: 20.	10

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The request ID.	0bc5df3a17****903790e8e8a
PagingInfo	object	The pagination result.
PageNumber	integer	The page number. Default value: 1.	1
PageSize	integer	The page size. Default value: 20.	10
TotalCount	integer	The total count.	12
SecurityStrategies	array<object>	The list of security policies.
	array<object>	A security policy.
Id	string	The policy ID.	12345
Name	string	The policy name.	默认数据分析策略
Description	string	The policy description.	控制数据分析模块的查询结果安全行为
SchemaName	string	The name of the schema template. Valid values: DataStudioMyCatalogSecurityStrategySchema : DataStudioMyCatalogSecurityStrategySchema DataQuerySecurityStrategySchema : DataQuerySecurityStrategySchema DataStudioSecurityStrategySchema : DataStudioSecurityStrategySchema	DataQuerySecurityStrategySchema
ControlModule	string	The control module.	DataQuery
ControlSubModule	string	The control submodule.	MyCatalog
ControlDwScope	string	The control scope. Valid values: `Workspace` and `Tenant`.	Tenant
Workspaces	array	The associated workspace IDs.
	integer	The workspace ID.	343434
Enabled	boolean	Whether the policy is enabled.	false
OriginPolicyId	integer	The source ID of the system default policy.	12
Creator	string	The user ID of the creator.	203322746501002787
Updater	string	The ID of the user who last updated the policy.	203322746501002787
CreateTime	string	The creation time.	2026-05-25T20:46:19
UpdateTime	string	The time of the last update.	2026-05-25T20:46:19
Content	object	The policy content. The content is constrained by `SecurityStrategySchema`.
Name	string	The `name` of the associated `SecurityStrategySchema`.	DataQuerySecurityStrategySchema
DisplayName	string	The `displayName` of the associated `SecurityStrategySchema`.	数据分析
DisplayNameEn	string	The `displayNameEn` of the associated `SecurityStrategySchema`.	Data Query
ControlModule	string	The control module. This value is from the `controlModule` property of the associated `SecurityStrategySchema`.	DataQuery
ControlSubModule	string	The control submodule. This value is from the `controlSubModule` property of the associated `SecurityStrategySchema`.	MyCatalog
ControlDwScope	string	The control scope. Valid values: Tenant : Tenant Workspace : Workspace	Tenant
SystemPolicyName	string	The name of the system policy. If this property is 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<object>	A list of control items. The available items depend on the schema. For details, see the `Controller` definition and the list of control items for each schema.
	object	A control item.
Controller	string	The identifier of the control item. For valid values, see the list of control items for each schema.	viewCount
DisplayName	string	The display name.	查询结果-单次展示记录值上限
DisplayNameEn	string	The display name in English.	Query Results - Single Display Record Limit
Enable	boolean	Whether the control item is enabled.
ControllerValueType	string	The data type of the value. Valid values: `Boolean`, `Integer`, `Long`, and `String`.	Integer
UserConfigValue	any	The value set for the control item. The data type of this value is specified by `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 for Basic Edition, specified as [min, max].
	integer	A boundary value of the range.	0
StandardEditionIntervalValue	array	The valid value range for Standard Edition, specified as [min, max].
	integer	A boundary value of the range.	0
ProfessionalEditionIntervalValue	array	The valid value range for Professional Edition, specified as [min, max].
	integer	A boundary value of the range.	0
EnterpriseEditionIntervalValue	array	The valid value range for Enterprise Edition, specified as [min, max].
	integer	A 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": "默认数据分析策略",
        "Description": "控制数据分析模块的查询结果安全行为",
        "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": "数据分析",
          "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": "查询结果-单次展示记录值上限",
              "DisplayNameEn": "Query Results - Single Display Record Limit",
              "Enable": false,
              "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.