GetSecurityStrategy-阿里云帮助中心

Retrieves the details of a security policy by its ID. This operation requires both DataWorks tenant administrator and security administrator permissions.

Operation description

Request

This API retrieves the complete configuration information for a security policy by its ID.
The API returns an error message if the provided Id is invalid or does not exist.
The response includes basic policy information, such as its name and description, and policy details, such as control items and their settings.
Note: Some fields in a system default policy cannot be modified or deleted.

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
Id	integer	Yes	The ID of the security strategy.	13

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	0bc5df3a17****903790e8e8a
SecurityStrategy	object	The security policy.
Id	integer	The policy ID.	13
Name	string	The policy name.	默认数据分析策略
Description	string	The policy description.	控制数据分析模块的查询结果安全行为
SchemaName	string	The name of the schema template.	DataQuerySecurityStrategySchema
ControlModule	string	The control module.	DataQuery
ControlSubModule	string	The control submodule.	MyCatalog
ControlDwScope	string	The scope where the policy is effective. Valid values: `Workspace` or `Tenant`.	Tenant
Workspaces	array	The list of associated workspace IDs.
	integer	The workspace ID.	4843434
Enabled	boolean	Whether the security policy is enabled.	true
OriginPolicyId	integer	The source ID of the default system policy.	12
Creator	string	The ID of the creator.	203322746501002787
Updater	string	The ID of the last updater.	203322746501002787
CreateTime	string	The time when the security policy was created.	2026-05-25T20:46:19
UpdateTime	string	The time when the security policy was last updated.	2026-05-25T20:46:19
Content	object	The content of the security policy. Its structure is defined by the `SecurityStrategySchema`.
Name	string	The `name` field from the associated `SecurityStrategySchema`.	DataQuerySecurityStrategySchema
DisplayName	string	The `displayName` field from the associated `SecurityStrategySchema`.	数据分析
DisplayNameEn	string	The `displayNameEn` field from the associated `SecurityStrategySchema`.	Data Query
ControlModule	string	The control module. This value corresponds to `controlModule` in the associated `SecurityStrategySchema`.	DataQuery
ControlSubModule	string	The control submodule. This value corresponds to `controlSubModule` in the associated `SecurityStrategySchema`.	MyCatalog
ControlDwScope	string	The scope where the policy is effective. Valid values: Valid values: Tenant : Applies at the tenant level. Workspace : Applies at the workspace level.	Tenant
SystemPolicyName	string	The name of the system policy. If specified, a default policy is automatically created.	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 controllers. Note: The available controllers depend on the selected schema. See the documentation for your schema for a list of valid controllers.
	object	A controller.
Controller	string	The identifier for the controller. For valid values, see the documentation for the relevant schema.	viewCount
DisplayName	string	The display name.	查询结果-单次展示记录值上限
DisplayNameEn	string	The display name in English.	Query Results - Single Display Record Limit
Enable	boolean	Whether the controller is enabled.	true
ControllerValueType	string	The value type of the controller. Valid values are `Boolean`, `Integer`, `Long`, and `String`.	Integer
UserConfigValue	any	The value configured by the user. The data type of this value is specified by the `ControllerValueType` parameter.	10
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 an array `[min, max]`.
	integer	The start or end value of the range.	0
StandardEditionIntervalValue	array	The valid value range for Standard Edition, specified as an array `[min, max]`.
	integer	The start or end value of the range.	0
ProfessionalEditionIntervalValue	array	The valid value range for Professional Edition, specified as an array `[min, max]`.
	integer	The start or end value of the range.	0
EnterpriseEditionIntervalValue	array	The valid value range for Enterprise Edition, specified as an array `[min, max]`.
	integer	The start or end value of the range.	0

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17****903790e8e8a",
  "SecurityStrategy": {
    "Id": 13,
    "Name": "默认数据分析策略",
    "Description": "控制数据分析模块的查询结果安全行为",
    "SchemaName": "DataQuerySecurityStrategySchema",
    "ControlModule": "DataQuery",
    "ControlSubModule": "MyCatalog",
    "ControlDwScope": "Tenant",
    "Workspaces": [
      4843434
    ],
    "Enabled": true,
    "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": true,
          "ControllerValueType": "Integer",
          "UserConfigValue": "10",
          "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.