ListEntitiesForPolicy

Download PDF

ListEntitiesForPolicy

最后更新时间：2023-03-15 10:25:07

下载PDF

1. API Description

Domain name for API request: cam.tencentcloudapi.com.

This API (ListEntitiesForPolicy) is used to query the list of entities associated with a policy.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ListEntitiesForPolicy.
Version	Yes	String	Common Params. The value used for this API: 2019-01-16.
Region	No	String	Common Params. This parameter is not required for this API.
PolicyId	Yes	Integer	Policy ID
Page	No	Integer	Page number, which starts from 1. Default is 1
Rp	No	Integer	Number of entries per page; 20 by default
EntityFilter	No	String	Valid values: `All`, `User`, `Group`, and `Role`. `All` means all entity types will be returned; `User` means only sub-accounts will be returned; `Group` means only User Groups will be returned; `Role` means only roles will be returned. `All` is the default value.

3. Output Parameters

Parameter Name	Type	Description
TotalNum	Integer	Number of entities Note: This field may return null, indicating that no valid value was found.
List	Array of AttachEntityOfPolicy	Entity list Note: This field may return null, indicating that no valid value was found.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of entities associated with a policy

Input Example

https://cam.tencentcloudapi.com/?Action=ListEntitiesForPolicy
&PolicyId=524497
&Page=1
&Rp=10
&EntityFilter=All
&<Common request parameters>

Output Example

{
    "Response": {
        "List": [
            {
                "Id": "1133398",
                "RelatedType": 1,
                "Uin": 3449203261,
                "AttachmentTime": "2021-11-11 19:38:01",
                "Name": "test1"
            }
        ],
        "TotalNum": 1,
        "RequestId": "836d7034-9854-44f0-9d4a-ee57842f8644"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.SystemError	Internal error.
InvalidParameter.EntityFilterError	`EntityFilter` field invalid.
InvalidParameter.ParamError	Invalid input parameter.
InvalidParameter.PolicyIdError	Input parameter `PolicyId` invalid.

tencent cloud

Recent Pages

ListEntitiesForPolicy

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the list of entities associated with a policy

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

ListEntitiesForPolicy

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the list of entities associated with a policy

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？