CreateProhibitedPolicy - 创建禁用软件策略-办公安全平台(SASE)-阿里云帮助中心

创建禁用软件策略。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Name	string	是	软件禁用策略名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-），不支持空格。	autotest_a0344d22
Description	string	否	软件禁用策略描述。长度不超过 128 个字符，允许为空。	project name pass the check
PolicyType	string	是	处置动作。取值： Ban：禁止运行并在终端弹窗提醒终端用户。 BanSilent：禁止运行且不提醒终端用户，静默阻断。 Warn：仅在终端弹窗提醒终端用户，不阻断软件运行。枚举值： BanSilent : 禁用且不提醒 Ban : 禁用并弹窗提醒 Warn : 仅弹窗提醒	Warn
Enabled	boolean	是	策略是否启用。取值： true：启用，策略会下发到终端并生效。 false：停用，策略保留配置但不下发到终端。	true
Whitelist	array	否	例外用户名列表。
	string	否	用户名。	王先生
PromptCh	string	是	终端弹窗的中文提示内容。	test
PromptEn	string	是	终端弹窗的英文提示内容。	Auto test prohibition prompt
Priority	integer	是	策略优先级。取值范围：0~99，数值越小优先级越高。	99
ObjectType	string	是	管控对象类型。取值： App：按禁用软件管控，管控对象由 SoftwareIds 指定。 Tag：按禁用软件标签管控，管控对象由 TagIds 指定，标签内的全部禁用软件均被管控。枚举值： App : 按禁用软件生效 Tag : 按禁用软件标签生效	App
SoftwareIds	array<object>	否	该策略直接管控的禁用软件集合。
	object	否	禁用软件的唯一标识。
SoftwareId	string	否	禁用软件 ID。取值来源： ListProhibitedSoftware ：批量查询禁用软件。 CreateProhibitedSoftware ：创建自定义禁用软件。	swb-df1fa76d889b****
IsDefault	boolean	否	该禁用软件是否为系统内置禁用软件。取值： true：系统内置禁用软件，所有阿里云账号共享，不支持修改和删除。 false：当前阿里云账号下的自定义禁用软件。	true
TagIds	array	否	该策略管控的禁用软件标签 ID 集合。
	string	否	禁用软件标签 ID。取值来源： ListProhibitedTags ：批量查询禁用软件标签。 CreateProhibitedTag ：创建自定义禁用软件标签。	tag-d3f64e8bdd4a****
MatchMode	string	是	生效范围。取值： UserGroupAll：对当前阿里云账号下的全部用户生效，不需要指定用户组。 UserGroupNormal：仅对 UserGroupIds 指定的用户组内的用户生效。枚举值： UserGroupNormal : 部分用户组生效 UserGroupAll : 全员生效	UserGroupAll
UserGroupIds	array	否	策略生效的用户组 ID 集合。
	string	否	用户组 ID。	usergroup-9d4f2a7b3c1e****
AllowReport	string	否	是否允许终端用户对该策略发起报备申请。取值： true：允许报备，终端弹窗提供报备入口。 false：不允许报备。	false
ForceKill	boolean	否	是否强制结束已运行的软件进程。取值： true：终端在命中策略时立即结束该软件正在运行的进程。 false：不结束已运行的进程，仅阻止后续启动。	false
TitleCh	string	否	终端弹窗的中文标题。	软件禁用提醒
TitleEn	string	否	终端弹窗的英文标题。	Software Blocked
MainButtonTextCh	string	否	终端弹窗主按钮的中文文案。	前往报备
MainButtonTextEn	string	否	终端弹窗主按钮的英文文案。	Report
MinorButtonTextCh	string	否	终端弹窗次按钮的中文文案。	我知道了
MinorButtonTextEn	string	否	终端弹窗次按钮的英文文案。	I know

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	215060E3-03D2-548D-A014-17941EA3B6C8
Policy	object	软件禁用策略详情。
Name	string	软件禁用策略名称。	autotest_846acf98
PolicyId	string	软件禁用策略 ID。	pid-dcbfd33cb004****
Description	string	软件禁用策略描述。	OK
PromptCh	string	终端弹窗的中文提示内容。	test
PromptEn	string	终端弹窗的英文提示内容。	L0 auto test prompt
PolicyType	string	处置动作。取值： Ban：禁止运行并在终端弹窗提醒终端用户。 BanSilent：禁止运行且不提醒终端用户，静默阻断。 Warn：仅在终端弹窗提醒终端用户，不阻断软件运行。枚举值： BanSilent : 禁用且不提醒 Ban : 禁用并弹窗提醒 Warn : 仅弹窗提醒	Ban
Whitelist	array	例外用户名列表。
	string	用户名。	王先生
Priority	integer	策略优先级。取值范围：0~99，数值越小优先级越高。	1
ObjectType	string	管控对象类型。取值： App：按禁用软件管控，管控对象由 SoftwareIds 指定。 Tag：按禁用软件标签管控，管控对象由 TagIds 指定，标签内的全部禁用软件均被管控。枚举值： App : 按禁用软件管控 Tag : 按禁用软件标签管控	App
Enabled	boolean	策略是否启用。取值： true：启用，策略会下发到终端并生效。 false：停用，策略保留配置但不下发到终端。	false
MatchMode	string	生效范围。取值： UserGroupAll：对当前阿里云账号下的全部用户生效，不需要指定用户组。 UserGroupNormal：仅对 UserGroupIds 指定的用户组内的用户生效。枚举值： UserGroupNormal : 部分用户组生效 UserGroupAll : 全员生效	UserGroupNormal
CreateTime	string	软件禁用策略的创建时间，格式为 yyyy-MM-dd HH:mm:ss，使用 UTC+8 时区。	2021-07-29 11:26:02
SoftwareIds	array<object>	该策略直接管控的禁用软件集合。
	object	禁用软件的唯一标识。
SoftwareId	string	禁用软件 ID。取值来源： ListProhibitedSoftware ：批量查询禁用软件。 CreateProhibitedSoftware ：创建自定义禁用软件。	swb-9a0bfde19662****
IsDefault	boolean	该禁用软件是否为系统内置禁用软件。取值： true：系统内置禁用软件，所有阿里云账号共享，不支持修改和删除。 false：当前阿里云账号下的自定义禁用软件。	true
TagIds	array	该策略管控的禁用软件标签 ID 集合。
	string	禁用软件标签 ID。	tag-d3f64e8bdd4a****
UserGroupIds	array	策略生效的用户组 ID 集合
	string	用户组 ID。	usergroup-9d4f2a7b3c1e****
AllowReport	boolean	是否允许终端用户对该策略发起报备申请。取值： true：允许报备，终端弹窗提供报备入口。 false：不允许报备。	false
ForceKill	boolean	是否强制结束已运行的软件进程。取值： true：终端在命中策略时立即结束该软件正在运行的进程。 false：不结束已运行的进程，仅阻止后续启动。	false
TitleCh	string	终端弹窗的中文标题。	软件禁用提醒
TitleEn	string	终端弹窗的英文标题。	Software Blocked
MainButtonTextCh	string	终端弹窗主按钮的中文文案。	前往报备
MainButtonTextEn	string	终端弹窗主按钮的英文文案。	Report
MinorButtonTextCh	string	终端弹窗次按钮的中文文案。	我知道了
MinorButtonTextEn	string	终端弹窗次按钮的英文文案。	I know

示例

正常返回示例

JSON格式

{
  "RequestId": "215060E3-03D2-548D-A014-17941EA3B6C8",
  "Policy": {
    "Name": "autotest_846acf98",
    "PolicyId": "pid-dcbfd33cb004****",
    "Description": "OK",
    "PromptCh": "test",
    "PromptEn": "L0 auto test prompt",
    "PolicyType": "Ban",
    "Whitelist": [
      "王先生"
    ],
    "Priority": 1,
    "ObjectType": "App",
    "Enabled": false,
    "MatchMode": "UserGroupNormal",
    "CreateTime": "2021-07-29 11:26:02",
    "SoftwareIds": [
      {
        "SoftwareId": "swb-9a0bfde19662****",
        "IsDefault": true
      }
    ],
    "TagIds": [
      "tag-d3f64e8bdd4a****\n"
    ],
    "UserGroupIds": [
      "usergroup-9d4f2a7b3c1e****"
    ],
    "AllowReport": false,
    "ForceKill": false,
    "TitleCh": "软件禁用提醒",
    "TitleEn": "Software Blocked",
    "MainButtonTextCh": "前往报备",
    "MainButtonTextEn": "Report",
    "MinorButtonTextCh": "我知道了",
    "MinorButtonTextEn": "I know"
  }
}

错误码

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

变更历史

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