ListRegistrationPolicies-阿里云帮助中心

Query the list of device registration policies for your Alibaba Cloud account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

csas:ListRegistrationPolicies

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	The current page number for paged queries. Values range from 1 to 10000.	1
PageSize	integer	Yes	The number of items per page for paged queries. Values range from 1 to 500.	10
Name	string	No	The name of the device registration policy. It can be 1 to 128 characters long. It supports Chinese characters, uppercase and lowercase English letters, numbers, periods (.), underscores (_), and hyphens (-).	registration_policy_name
UserGroupId	string	No	The user group ID. Get this value from: ListUserGroups: Batch query user groups. CreateUserGroup: Create user groups.	usergroup-6f1ef2fc56b6****
CompanyLimitType	string	No	The type of company device registration limit. Valid values: Unlimited: No limit. LimitAll: Limit by total number. LimitDiff: Limit by device categorization. Valid values: LimitAll : Limit by total number LimitDiff : Limit by device categorization Unlimited : No limit	LimitAll
PersonalLimitType	string	No	The type of personal device registration limit. Valid values: Unlimited: No limit. LimitAll: Limit by total number. LimitDiff: Limit by device categorization. Valid values: LimitAll : Limit by total number LimitDiff : Limit by device categorization Unlimited : No limit	LimitDiff
Status	string	No	The status of the device registration policy. Valid values: Enabled: Enabled. Disabled: Disabled. Valid values: Enabled : Enabled Disabled : Disabled	Enabled
MatchMode	string	No	The policy matching target type. Valid values: UserGroupAll: Associate all users. UserGroupNormal: Associate some user groups. Valid values: UserGroupNormal : Associate some user groups UserGroupAll : Associate all users	UserGroupAll
PolicyIds	array	No	A collection of device registration policy IDs. You can enter up to 100 device registration policy IDs.
	string	No	The device registration policy ID. Get this value from: ListRegistrationPolicies: Batch query device registration policies. GetRegistrationPolicy: Query device registration policy details. CreateRegistrationPolicy: Create device registration policies. UpdateRegistrationPolicy: Update device registration policies.	reg-policy-63b2f1844b86****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of this request.	7A8FE38A-E29C-5678-B84A-FEDBCB83552F
TotalNum	string	The total number of device registration policies.	1
Policies	array<object>	The list of device registration policies.
	array<object>	A device registration policy.
Name	string	The name of the device registration policy.	registration_policy_name
PolicyId	string	The ID of the device registration policy.	reg-policy-dcbfd33cb004****
Description	string	The description of the device registration policy.	这是一条设备注册策略。
Priority	integer	The policy priority for device registration. A value of 0 indicates the highest priority, and 99 indicates the lowest priority.	1
Whitelist	array	The whitelist of users for the device registration policy.
	string	A whitelisted user for the device registration policy.	王先生
Status	string	The status of the device registration policy. Valid values: Enabled: Enabled. Disabled: Disabled. Valid values: Enabled : Enabled Disabled : Disabled	Enabled
MatchMode	string	The policy matching target type. Valid values: UserGroupAll: Associate all users. UserGroupNormal: Associate some user groups. Valid values: UserGroupNormal : Associate some user groups UserGroupAll : Associate all users	UserGroupNormal
UserGroupIds	array	A collection of user group IDs for the device registration policy. This field has a value when the policy matching target type is UserGroupNormal.
	string	The user group ID for the device registration policy when the policy matching target type is UserGroupNormal.	usergroup-086bcf2d650b****
CreateTime	string	The creation time of the device registration policy.	2023-05-16 17:18:46
LimitDetail	array<object>	The list of device registration policy limit details.
	array<object>	Details of a device registration policy limit.
DeviceBelong	string	The device ownership. Valid values: Company: Company device. Personal: Personal device. Valid values: Company : Company device Personal : Personal device	Company
LimitType	string	The type of device registration limit. Valid values: Unlimited: No limit. LimitAll: Limit by total number. LimitDiff: Limit by device categorization. Valid values: LimitAll : Limit by total number LimitDiff : Limit by device categorization Unlimited : No limit	LimitAll
LimitCount	object	The number of device registration limits.
All	integer	The total number of device registration limits. This field is valid when the device registration limit type is LimitAll.	3
PC	integer	The number of PC client log ons allowed for device registration. This field is valid when the device registration limit type is LimitDiff.	0
Mobile	integer	The number of mobile client log ons allowed for device registration. This field is valid when the device registration limit type is LimitDiff.	0

The policy list is sorted in descending order of priority and ascending order of creation time.

Examples

Success response

JSON format

{
  "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
          }
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.