GetSecurityStrategy - 查询安全策略详情

更新时间:
复制 MD 格式

根据提供的安全策略ID,获取对应的安全策略详细信息。

接口说明

请求说明

  • 该 API 用于通过指定的安全策略 ID 来检索特定安全策略的全部配置信息。

  • 确保提供的Id参数值有效且存在,否则将返回错误信息。

  • 返回的数据结构包括了策略的基本信息(如名称、描述等)以及详细的策略内容(如管控项及其设置)。

  • 注意:系统默认策略的部分字段可能不允许修改或删除。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetSecurityStrategy

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Id

integer

是

安全策略 ID

13

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

API 请求 ID

0bc5df3a17****903790e8e8a

SecurityStrategy

object

安全策略

Id

integer

策略 ID

13

Name

string

策略名称

默认数据分析策略

Description

string

策略描述

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

SchemaName

string

Schema 模板名称

枚举值:

  • DataStudioMyCatalogSecurityStrategySchema :

    数据开发个人数据目录安全策略模式

  • DataQuerySecurityStrategySchema :

    数据分析安全策略模式

  • DataStudioSecurityStrategySchema :

    数据开发安全策略模式

DataQuerySecurityStrategySchema

ControlModule

string

管控模块

枚举值:

  • DataStudio :

    数据开发

  • DataQuery :

    数据分析

DataQuery

ControlSubModule

string

管控子模块

枚举值:

  • MyCatalog :

    个人数据目录

MyCatalog

ControlDwScope

string

管控范围(Workspace/Tenant)

枚举值:

  • Tenant :

    租户

  • Workspace :

    工作空间

Tenant

Workspaces

array

关联工作空间 ID 列表

integer

工作空间 ID

4843434

Enabled

boolean

是否启用

true

OriginPolicyId

integer

系统默认策略来源 ID

12

Creator

string

创建者用户 ID

203322746501002787

Updater

string

最后更新者用户 ID

203322746501002787

CreateTime

string

创建时间,格式为 YYYY-MM-DDTHH:mm:ss;当前文档未声明时区。

2026-05-25T20:46:19

UpdateTime

string

更新时间,格式为 YYYY-MM-DDTHH:mm:ss;当前文档未声明时区。

2026-05-25T20:46:19

Content

object

策略内容,内容受 SecurityStrategySchema 约束

Name

string

当前策略关联的 SecurityStrategySchema.name

枚举值:

  • DataStudioMyCatalogSecurityStrategySchema :

    数据开发个人数据目录安全策略模式

  • DataQuerySecurityStrategySchema :

    数据分析安全策略模式

  • DataStudioSecurityStrategySchema :

    数据开发安全策略模式

DataQuerySecurityStrategySchema

DisplayName

string

当前策略关联的 SecurityStrategySchema. displayName

数据分析

DisplayNameEn

string

当前策略关联的 SecurityStrategySchema. displayNameEn

Data Query

ControlModule

string

控制模块。当前策略关联的 SecurityStrategySchema.controlModule

枚举值:

  • DataStudio :

    数据开发

  • DataQuery :

    数据分析

DataQuery

ControlSubModule

string

管控子模块。当前策略关联的 SecurityStrategySchema.controlSubModule

枚举值:

  • MyCatalog :

    个人数据目录

MyCatalog

ControlDwScope

string

生效范围

枚举值:

  • Tenant :

    Tenant

  • Workspace :

    Workspace

Tenant

SystemPolicyName

string

系统策略名称(非空时系统自动创建默认策略)

SYSTEM_GENERATE_DEFAULT_DATA_QUERY

SystemPolicyDisplayName

string

系统策略显示名称

Default system generate data query policy

Controllers

array<object>

管控项列表,

注意:合法管控项取决于所选 Schema,参考 Controller 定义 及 各 Schema 管控项列表

object

管控项

Controller

string

管控项标识符,取值见 各 Schema 管控项列表

viewCount

DisplayName

string

显示名称

查询结果-单次展示记录值上限

DisplayNameEn

string

英文显示名称

Query Results - Single Display Record Limit

Enable

boolean

是否启用该管控项

true

ControllerValueType

string

值类型(Boolean/Integer/Long/String)

Integer

UserConfigValue

any

用户配置值,类型取决于 ControllerValueType

10

BasicEditionDefaultValue

any

基础版默认值

10000

StandardEditionDefaultValue

any

标准版默认值

10000

ProfessionalEditionDefaultValue

any

专业版默认值

10000

EnterpriseEditionDefaultValue

any

企业版默认值

10000

BasicEditionIntervalValue

array

基础版有效值区间[min, max]

integer

区间起止值

0

StandardEditionIntervalValue

array

标准版有效值区间[min, max]

integer

区间起止值

0

ProfessionalEditionIntervalValue

array

专业版有效值区间[min, max]

integer

区间起止值

0

EnterpriseEditionIntervalValue

array

企业版有效值区间[min, max]

integer

区间起止值

0

示例

正常返回示例

JSON格式

{
  "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
          ]
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。