Cloud Services API ReferenceIndustrial ScenariosGeneral Permission ManagementManage RolesQuery Role Information on Pages

Query Role Information on Pages

Last Updated on : 2023-07-06 09:12:57download

Query the role information on pages according to the specified criteria.

API address

GET: /v1.0/iot-02/roles

Request parameter

Parameter name	Type	IN	Required	Description
request	RolePageQueryRequest	query	true	The request of querying roles.

Description of request

Parameter name	Type	Required	Description
role_codes	String	false	The list of role IDs, separated with commas (,).
role_name	String	false	The name of a specified role.
gmt_modified_asc	Boolean	false	Indicates whether to display the items in ascending order of the modification time.Valid values: `true`: yes. `false`: no. Default value.
page_no	Integer	false	The page number. Default value: `1`.
page_size	Integer	false	The number of items returned on each page. Default value: `20`.

Return parameter

Parameter name	Type	Description
result	PageResponse	The returned list of roles.

Description of result

Parameter name	Type	Description
total	Integer	The total number.
list	List	The list of results.
has_more	Boolean	Specifies whether there is a next page.

Description of list

Parameter name	Type	Description
role_code	String	The identifier of a specified role.
role_name	String	The name of a specified role.
remark	String	The remarks.

Request example

GET: /v1.0/iot-02/roles?role_codes=aaa,bbb&role_name=roleName&page_no=1&page_size=20&gmt_modified_asc=true

Return example

{
    "result": {
        "list": [
            {
                "role_code": "roleCodegcnI",
                "remark": "",
                "role_name": "role1"
            },
            {
                "role_code": "roleCode323j",
                "remark": "",
                "role_name": "role2"
            },
            {
                "role_code": "roleCodeSxSF",
                "remark": "",
                "role_name": "role3"
            },
            {
                "role_code": "roleCodeSbqO",
                "remark": "",
                "role_name": "role4"
            }
        ],
        "has_more": true
    }
}

Error code

For more information, see error code.

Prev DocUpdate Role Information

Next DocQuery Role Information