GetRegistrationPolicy - 查询设备注册策略详情

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

csas:GetRegistrationPolicy

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

PolicyId

string

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

reg-policy-dcbfd33cb004****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

本次请求的 ID。

47363C2B-1AAA-5954-8847-0E50FCC54117

Name

string

设备注册策略名称。

registration_policy_name

PolicyId

string

设备注册策略 ID。

reg-policy-dcbfd33cb004****

Description

string

设备注册策略描述。

这是一条设备注册策略。

Priority

integer

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

99

Whitelist

array

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

string

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

王先生

Status

string

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

  • Enabled:开启。

  • Disabled:关闭。

Enabled

MatchMode

string

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

  • UserGroupAll:关联全体用户。

  • UserGroupNormal:关联部分用户组。

UserGroupAll

UserGroupIds

array

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

string

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

usergroup-086bcf2d650b****

CreateTime

string

设备注册策略创建时间。

2023-05-16 17:18:46

LimitDetail

array<object>

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

array<object>

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

DeviceBelong

string

设备归属。取值:

  • Company:公司设备。

  • Personal:个人设备。

枚举值:

  • Company :

    公司设备

  • Personal :

    个人设备

Personal

LimitType

string

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

  • Unlimited:不限制。

  • LimitAll:按照总数限制。

  • LimitDiff:按照终端分类限制。

枚举值:

  • LimitAll :

    按照总数限制

  • LimitDiff :

    按照终端分类限制

  • Unlimited :

    不限制

LimitDiff

LimitCount

object

设备注册限制数量。

All

integer

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

0

PC

integer

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

2

Mobile

integer

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

2

示例

正常返回示例

JSON格式

{
  "RequestId": "47363C2B-1AAA-5954-8847-0E50FCC54117",
  "Name": "registration_policy_name",
  "PolicyId": "reg-policy-dcbfd33cb004****",
  "Description": "这是一条设备注册策略。",
  "Priority": 99,
  "Whitelist": [
    "王先生"
  ],
  "Status": "Enabled",
  "MatchMode": "UserGroupAll",
  "UserGroupIds": [
    "usergroup-086bcf2d650b****"
  ],
  "CreateTime": "2023-05-16 17:18:46",
  "LimitDetail": [
    {
      "DeviceBelong": "Personal",
      "LimitType": "LimitDiff",
      "LimitCount": {
        "All": 0,
        "PC": 2,
        "Mobile": 2
      }
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情