分页查询当前阿里云账号下的软件禁用策略列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CurrentPage |
integer |
是 |
分页查询时显示的当前页的页码。取值:1~10000。 |
1 |
| PageSize |
integer |
是 |
分页查询时设置的每页数量。取值:1~500。 |
10 |
| PolicyIds |
array |
否 |
软件禁用策略 ID 集合,不允许重复。 |
|
|
string |
否 |
软件禁用策略 ID。取值来源:
|
pid-2d8f3dbf2b9d**** |
|
| TagId |
string |
否 |
禁用软件标签 ID,用于筛选引用该标签的策略。取值来源:
|
tag-d3f64e8bdd4a**** |
| SoftwareId |
object |
否 |
禁用软件的唯一标识。 |
|
| SoftwareId |
string |
否 |
禁用软件 ID。取值来源:
|
swb-83995ff2ae38**** |
| IsDefault |
boolean |
否 |
是否为系统内置禁用软件。取值:
枚举值:
|
false |
| UserGroupId |
string |
否 |
用户组 ID,用于筛选生效范围包含该用户组的策略。取值来源:
|
usergroup-9d4f2a7b3c1e**** |
| Name |
string |
否 |
软件禁用策略名称,支持模糊查询。长度不超过 128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-),不支持空格。 |
test |
| PolicyType |
string |
否 |
处置动作。取值:
枚举值:
|
Ban |
| Enabled |
boolean |
否 |
策略是否启用。取值:
枚举值:
|
true |
| ObjectType |
string |
否 |
管控对象类型。取值:
枚举值:
|
App |
| MatchMode |
string |
否 |
生效范围。取值:
枚举值:
|
UserGroupAll |
| SoftwareName |
string |
否 |
禁用软件名称,支持模糊查询。长度不超过 128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-),不支持空格。 |
Thunder |
| TagName |
string |
否 |
禁用软件标签名称,支持模糊查询。长度不超过 128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-),不支持空格。 |
云产品 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
03362EE0-C6F7-51ED-91FF-0BFFA5A2AB67 |
| TotalNum |
integer |
软件禁用策略总数。 |
1 |
| Policies |
array<object> |
软件禁用策略列表,按优先级从高到低排列。 |
|
|
array<object> |
软件禁用策略。 |
||
| SoftwareIds |
array<object> |
该策略直接管控的禁用软件集合。 |
|
|
object |
禁用软件。 |
||
| SoftwareId |
string |
禁用软件 ID。 |
swb-9a0bfde19662**** |
| IsDefault |
boolean |
该禁用软件是否为系统内置禁用软件。取值:
|
true |
| TagIds |
array |
该策略管控的禁用软件标签 ID 集合。 |
|
|
string |
禁用软件标签 ID。 |
tag-7b2c9e4a1d8f**** |
|
| UserGroupIds |
array |
该策略生效的用户组 ID 集合。 |
|
|
string |
用户组 ID。 |
usergroup-9d4f2a7b3c1e**** |
|
| Name |
string |
软件禁用策略名称。 |
test |
| PolicyId |
string |
软件禁用策略 ID。 |
pid-42f19f1b6a3e**** |
| Description |
string |
软件禁用策略描述。 |
test |
| PromptCh |
string |
终端弹窗的中文提示内容。 |
该软件已被企业安全策略禁止运行,如需使用请提交报备申请。 |
| PromptEn |
string |
终端弹窗的英文提示内容。 |
This software is blocked by your enterprise security policy. |
| PolicyType |
string |
处置动作。取值:
枚举值:
|
Warn |
| Whitelist |
array |
例外用户名列表。 |
|
|
string |
用户名。 |
王先生 |
|
| Priority |
integer |
策略优先级。取值范围:0~99,数值越小优先级越高。 |
1 |
| ObjectType |
string |
管控对象类型。取值:
枚举值:
|
App |
| Enabled |
boolean |
策略是否启用。取值:
|
true |
| MatchMode |
string |
策略匹配目标类型。取值:
枚举值:
|
UserGroupNormal |
| CreateTime |
string |
软件禁用策略的创建时间,格式为 yyyy-MM-dd HH:mm:ss,使用 UTC+8 时区。 |
2023-05-16 17:18:46 |
| AllowReport |
boolean |
是否允许终端用户对该策略发起报备申请。取值:
|
false |
| ForceKill |
boolean |
是否强制结束已运行的软件进程。取值:
|
false |
| TitleCh |
string |
终端弹窗的中文标题。 |
软件禁用提醒 |
| TitleEn |
string |
终端弹窗的英文标题。 |
Software Blocked |
| MainButtonTextCh |
string |
终端弹窗主按钮的中文文案。 |
去报备 |
| MainButtonTextEn |
string |
终端弹窗主按钮的英文文案。 |
Report |
| MinorButtonTextCh |
string |
终端弹窗次按钮的中文文案。 |
我知道了 |
| MinorButtonTextEn |
string |
终端弹窗次按钮的英文文案。 |
Got it |
示例
正常返回示例
JSON格式
{
"RequestId": "03362EE0-C6F7-51ED-91FF-0BFFA5A2AB67",
"TotalNum": 1,
"Policies": [
{
"SoftwareIds": [
{
"SoftwareId": "swb-9a0bfde19662****",
"IsDefault": true
}
],
"TagIds": [
"tag-7b2c9e4a1d8f****"
],
"UserGroupIds": [
"usergroup-9d4f2a7b3c1e****"
],
"Name": "test",
"PolicyId": "pid-42f19f1b6a3e****",
"Description": "test",
"PromptCh": "该软件已被企业安全策略禁止运行,如需使用请提交报备申请。",
"PromptEn": "This software is blocked by your enterprise security policy.",
"PolicyType": "Warn",
"Whitelist": [
"王先生"
],
"Priority": 1,
"ObjectType": "App",
"Enabled": true,
"MatchMode": "UserGroupNormal",
"CreateTime": "2023-05-16 17:18:46",
"AllowReport": false,
"ForceKill": false,
"TitleCh": "软件禁用提醒",
"TitleEn": "Software Blocked",
"MainButtonTextCh": "去报备",
"MainButtonTextEn": "Report",
"MinorButtonTextCh": "我知道了",
"MinorButtonTextEn": "Got it"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。