调用CreateRegistrationPolicy接口创建设备注册策略-办公安全平台-阿里云-办公安全平台(SASE)-阿里云帮助中心

创建当前阿里云账号下设备注册策略。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Name	string	是	设备注册策略名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	registration_policy_name
Description	string	否	设备注册策略描述。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。	这是一条设备注册策略
Status	string	是	设备注册策略状态。取值： Enabled：开启。 Disabled：关闭。	Enabled
Whitelist	array	否	设备注册策略白名单用户列表。最多可输入 1000 个用户名。
	string	否	设备注册策略白名单用户。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）、星号（*）、at（@）和空格。	王先生
Priority	long	否	设备注册策略优先级。数字 0 表示优先级最高，数字 99 表示优先级最低。	99
CompanyLimitType	string	是	公司设备注册限制类型。取值： Unlimited：不限制。 LimitAll：按照总数限制。 LimitDiff：按照终端分类限制。	LimitAll
CompanyLimitCount	object	否	公司设备注册限制数量。
All	integer	否	公司设备注册限制总数。取值范围为 0～100，默认为 0。当公司设备注册限制类型为 LimitAll 时，该字段的值有效。	1
PC	integer	否	公司设备注册限制 PC 端登录数量。取值范围为 0～100，默认为 0。当公司设备注册限制类型为 LimitDiff 时，该字段的值有效。	0
Mobile	integer	否	公司设备注册限制移动端登录数量。取值范围为 0～100，默认为 0。当公司设备注册限制类型为 LimitDiff 时，该字段的值有效。	0
PersonalLimitType	string	是	个人设备注册限制类型。取值： Unlimited：不限制。 LimitAll：按照总数限制。 LimitDiff：按照终端分类限制。	LimitDiff
PersonalLimitCount	object	否	个人设备注册限制数量。
All	integer	否	个人设备注册限制总数。取值范围为 0～100，默认为 0。当个人设备注册限制类型为 LimitAll 时，该字段的值有效。	0
PC	integer	否	个人设备注册限制 PC 端登录数量。取值范围为 0～100，默认为 0。当个人设备注册限制类型为 LimitDiff 时，该字段的值有效。	2
Mobile	integer	否	个人设备注册限制移动端登录数量。取值范围为 0～100，默认为 0。当个人设备注册限制类型为 LimitDiff 时，该字段的值有效。	3
MatchMode	string	是	策略匹配目标类型。取值： UserGroupAll：关联全体用户。 UserGroupNormal：关联部分用户组。	UserGroupAll
UserGroupIds	array	否	设备注册策略的用户组 ID 集合，当策略匹配目标类型为 UserGroupNormal 时必填。单个策略的用户组最大支持 100 个。
	string	否	设备注册策略，策略匹配目标类型为 UserGroupNormal 时的用户组 ID。取值来源： ListUserGroups ：批量查询用户组。 CreateUserGroup ：创建用户组。	usergroup-086bcf2d650b****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次请求的 ID。	FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE
Policy	object	设备注册策略。
Name	string	设备注册策略名称。	registration_policy_name
PolicyId	string	设备注册策略 ID。	reg-policy-dcbfd33cb004****
Priority	string	设备注册策略优先级。数字 0 表示优先级最高，数字 99 表示优先级最低。	1
Description	string	设备注册策略描述。	这是一条设备注册策略
Whitelist	array	设备注册策略白名单用户列表。
whitelist	string	设备注册策略白名单用户。	王先生
Status	string	设备注册策略状态。取值： Enabled：开启。 Disabled：关闭。	Enabled
MatchMode	string	策略匹配目标类型。取值： UserGroupAll：关联全体用户。 UserGroupNormal：关联部分用户组。	UserGroupNormal
UserGroupIds	array	设备注册策略，用户组 ID 集合。当策略匹配目标类型为 UserGroupNormal 时，该字段有值。
userGroupIds	string	设备注册策略，策略匹配目标类型为 UserGroupNormal 时的用户组 ID。	usergroup-086bcf2d650b****
CreateTime	string	设备注册策略创建时间。	2023-05-16 17:18:46
LimitDetail	array<object>	设备注册策略限制详情列表。
limitDetail	object	设备注册策略限制详情。
DeviceBelong	string	设备归属。取值： Company：公司设备。 Personal：个人设备。	Company
LimitType	string	设备注册限制类型。取值： Unlimited：不限制。 LimitAll：按照总数限制。 LimitDiff：按照终端分类限制。	LimitDiff
LimitCount	object	设备注册限制数量。
All	integer	设备注册限制总数。当设备注册限制类型为 LimitAll 时，该字段的值有效。	0
PC	integer	设备注册限制 PC 端登录数量。当设备注册限制类型为 LimitDiff 时，该字段的值有效。	2
Mobile	integer	设备注册限制移动端登录数量。当设备注册限制类型为 LimitDiff 时，该字段的值有效。	3

示例

正常返回示例

JSON格式

{
  "RequestId": "FEF1144C-95D1-5F7C-81EF-9DB70EA49FCE",
  "Policy": {
    "Name": "registration_policy_name",
    "PolicyId": "reg-policy-dcbfd33cb004****",
    "Priority": 1,
    "Description": "这是一条设备注册策略",
    "Whitelist": [
      "王先生"
    ],
    "Status": "Enabled",
    "MatchMode": "UserGroupNormal",
    "UserGroupIds": [
      "usergroup-086bcf2d650b****"
    ],
    "CreateTime": "2023-05-16 17:18:46",
    "LimitDetail": [
      {
        "DeviceBelong": "Company",
        "LimitType": "LimitDiff",
        "LimitCount": {
          "All": 0,
          "PC": 2,
          "Mobile": 3
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-03	API 内部配置变更，不影响调用	查看变更详情