Cloud Services API ReferenceGeneral ServiceIdentity and Access ManagementPermission ManagementQuery Permission Data of Project

Query Permission Data of Project

Last Updated on : 2023-10-09 08:06:54download

Based on the permission name, fuzzy query the permission data under the current project.

API address

GET: /v2.0/cloud/iam/permission/query

Request parameter

Parameter name	Type	IN	Required	Description
permission_name	String	query	true	The name of the specified permission.
last_row_key	Long	query	false	The starting ID of the query.
page_size	Integer	query	false	The number of items returned on each page.

Return parameter

Parameter name	Type	Description
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
error_code	String	The error code. For more information, see the error codes.
error_msg	String	The message that is returned if the request fails. It is empty if the request is successful.
result	QueryPermissionByLikeNameRes	The returned result.

Description of result

Parameter name	Type	Description
permission_and_permission_item_list	List	The list of permissions.
last_row_key	Long	The starting ID of the query.
page_size	Integer	The number of items returned on each page.
total	Integer	The total number of returned entries.

Description of permission_and_permission_item_list

Parameter name	Type	Description
permission_id	Long	The ID of the specified permission.
name	String	The name of the specified permission.
description	String	The description of the specified permission.
permission_item_list	List	The list of sub-permissions.
gmt_create	Long	The creation time.

Description of permission_item_list

Parameter name	Type	Description
item_id	Long	The ID of the specified sub-permission.
policy_id	Long	The ID of the specified policy.
policy_name	String	The name of the specified policy.
resource_id	String	The ID of the specified resource.
resource_type	Integer	The type of the specified resource. Valid values: `1`: space resource. `2`: device resource. `11`: global resource type.
item_type	Integer	The type of the specified sub-permission. Valid values: `1`: The space contains subgroups. `0`: The space does not contain subgroups.

Request example

GET: /v2.0/cloud/iam/permission/query?permission_name=name1&lastRowKey=0&pageSize=100

Return example

{
    "tid": "195bceee56b411ee801ef25dabf95fef",
    "result": {
        "last_row_key": 181044,
        "permission_and_permission_item_list": [
            {
                "gmt_create": 1695104201,
                "permission_item_list": [
                    {
                        "policy_id": 110001,
                        "item_id": 232371810,
                        "item_type": 0,
                        "resource_type": 11,
                        "resource_id": "*"
                    }
                ],
                "description": "Description",
                "permission_id": 232371810,
                "name": "Permission name"
            }
        ],
        "total": 15,
        "page_size": 10
    },
    "t": 1695104201504,
    "success": true
}

Error code

For more information, see error code.

Prev DocCreate Permission

Next DocQuery Permission