Help & DocumentationAPIsCloud Access ManagementPolicy APIsListAttachedGroupPolicies

ListAttachedGroupPolicies

Last updated: 2020-03-16 16:43:45

1. API Description

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

This API (ListAttachedGroupPolicies) is used to query the list of policies associated with a user group.

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

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 parameter. The value used for this API: ListAttachedGroupPolicies.
Version Yes String Common parameter. The value used for this API: 2019-01-16.
Region No String Common parameter. This parameter is not required for this API.
TargetGroupId Yes Integer User group ID
Page No Integer Page number, which starts from 1. Default is 1
Rp No Integer Number of entries per page; 20 by default

3. Output Parameters

Parameter Name Type Description
TotalNum Integer Total number of policies
List Array of AttachPolicyInfo Policy list
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 policies associated with a user group

This example shows you how to query the list of policies associated with a user group (ID: 3349)

Input Example

https://cam.tencentcloudapi.com/?Action=ListAttachedGroupPolicies
&TargetGroupId=3349
&Page=1
&Rp=10
&<Common request parameters>

Output Example

{
  "Response": {
    "List": [
      {
        "PolicyId": 1,
        "PolicyName": "AdministratorAccess",
        "AddTime": "2018-04-09 16:31:19",
        "CreateMode": 2,
        "PolicyType": "User"
      }
    ],
    "TotalNum": 1,
    "RequestId": "836d7034-9854-44f0-9d4a-ee57842f8644"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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.ParamError Invalid input parameter.