ListRegistrationPolicies - 批量查询设备注册策略

查询当前阿里云账号下设备注册策略列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
csas:ListRegistrationPoliciesget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CurrentPagelong

分页查询时显示的当前页的页码。取值:1~10000。

1
PageSizelong

分页查询时设置的每页数量。取值:1~500。

10
Namestring

设备注册策略名称。长度为 1~128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

registration_policy_name
UserGroupIdstring

用户组 ID。取值来源:

usergroup-6f1ef2fc56b6****
CompanyLimitTypestring

公司设备注册限制类型。取值:

  • Unlimited:不限制。
  • LimitAll:按照总数限制。
  • LimitDiff:按照终端分类限制。
LimitAll
PersonalLimitTypestring

个人设备注册限制类型。取值:

  • Unlimited:不限制。
  • LimitAll:按照总数限制。
  • LimitDiff:按照终端分类限制。
LimitDiff
Statusstring

设备注册策略状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
MatchModestring

策略匹配目标类型。取值:

  • UserGroupAll:关联全体用户。
  • UserGroupNormal:关联部分用户组。
UserGroupAll
PolicyIdsarray

设备注册策略 ID 集合。最多可输入 100 个设备注册策略 ID。

string

设备注册策略 ID。取值来源:

reg-policy-63b2f1844b86****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次请求的 ID。

7A8FE38A-E29C-5678-B84A-FEDBCB83552F
TotalNumstring

设备注册策略总数。

1
Policiesarray<object>

设备注册策略列表。

dataListobject

设备注册策略。

Namestring

设备注册策略名称。

registration_policy_name
PolicyIdstring

设备注册策略 ID。

reg-policy-dcbfd33cb004****
Descriptionstring

设备注册策略描述。

这是一条设备注册策略。
Prioritylong

设备注册策略优先级。数字 0 表示优先级最高,数字 99 表示优先级最低。

1
Whitelistarray

设备注册策略白名单用户列表。

whiteliststring

设备注册策略白名单用户。

王先生
Statusstring

设备注册策略状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
MatchModestring

策略匹配目标类型。取值:

  • UserGroupAll:关联全体用户。
  • UserGroupNormal:关联部分用户组。
UserGroupNormal
UserGroupIdsarray

设备注册策略,用户组 ID 集合。当策略匹配目标类型为 UserGroupNormal 时,该字段有值。

userGroupIdsstring

设备注册策略,策略匹配目标类型为 UserGroupNormal 时的用户组 ID。

usergroup-086bcf2d650b****
CreateTimestring

设备注册策略创建时间。

2023-05-16 17:18:46
LimitDetailarray<object>

设备注册策略限制详情列表。

limitDetailobject

设备注册策略限制详情。

DeviceBelongstring

设备归属。取值:

  • Company:公司设备。
  • Personal:个人设备。
Company
LimitTypestring

设备注册限制类型。取值:

  • Unlimited:不限制。
  • LimitAll:按照总数限制。
  • LimitDiff:按照终端分类限制。
LimitAll
LimitCountobject

设备注册限制数量。

Allinteger

设备注册限制总数。当设备注册限制类型为 LimitAll 时,该字段的值有效。

3
PCinteger

设备注册限制 PC 端登录数量。当设备注册限制类型为 LimitDiff 时,该字段的值有效。

0
Mobileinteger

设备注册限制移动端登录数量。当设备注册限制类型为 LimitDiff 时,该字段的值有效。

0

策略列表按照优先级从高至低、创建时间由晚至早的顺序返回。

示例

正常返回示例

JSON格式

{
  "RequestId": "7A8FE38A-E29C-5678-B84A-FEDBCB83552F",
  "TotalNum": "1",
  "Policies": [
    {
      "Name": "registration_policy_name",
      "PolicyId": "reg-policy-dcbfd33cb004****",
      "Description": "这是一条设备注册策略。",
      "Priority": 1,
      "Whitelist": [
        "王先生"
      ],
      "Status": "Enabled",
      "MatchMode": "UserGroupNormal",
      "UserGroupIds": [
        "usergroup-086bcf2d650b****"
      ],
      "CreateTime": "2023-05-16 17:18:46",
      "LimitDetail": [
        {
          "DeviceBelong": "Company",
          "LimitType": "LimitAll",
          "LimitCount": {
            "All": 3,
            "PC": 0,
            "Mobile": 0
          }
        }
      ]
    }
  ]
}

错误码

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