Cloud Services API ReferenceGeneral ServiceIdentity and Access ManagementPolicy ManagementQuery Policy List

Query Policy List

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

Query the detailed list of policies on pages.

API address

GET: /v2.0/cloud/iam/policy/list

Request parameter

Parameter name	Type	IN	Required	Description
last_row_key	Long	query	false	The ID of the specified starting policy. If it is left empty, the query is started from the first entry.
page_size	Integer	query	true	The number of items returned on each page.

Return parameter

Parameter name	Type	Description
result	List	The returned result.
success	Boolean	Indicates whether the request is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
error_code	String	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.

Description of result

Parameter name	Type	Description
policy_id	Long	The ID of the specified policy.
name	String	The name of the specified policy.
allow_action	List	The Allow action, which describes the specific actions allowed.
deny_action	List	The Deny action, which describes the specific actions denied.
description	String	The description of the specified policy.
gmt_create	Long	The creation time.
gmt_modified	Long	The time when it is modified.

Request example

GET: /v2.0/cloud/iam/policy/list?page_size=10&last_row_key=0

Return example

{
    "tid": "16868012577231686801257723",
    "result": [
        {
            "gmtModified": 1686559156,
            "description": "Policy description",
            "gmtCreate": 1686558615,
            "policyId": 1,
            "denyAction": [
                "*"
            ],
            "name": "Policy Name"
        }
    ],
    "t": 1686801257723,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify Policy

Next DocQuery Available Actions