PrevNext
search by keyword

Recent Pages

Documentation
Documentation

ListAttachedGroupPolicies

Last updated: 2021-09-02 10:37:31

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.

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 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
Keyword No String Search by keyword

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": [
      {
        "OperateOwnerUin": "xx",
        "PolicyName": "AdministratorAccess",
        "Remark": "xx",
        "OperateUinType": 1,
        "CreateMode": 1,
        "Deactived": 1,
        "AddTime": "2020-09-22 00:00:00",
        "PolicyType": "User",
        "PolicyId": 1,
        "DeactivedDetail": [
          "xx"
        ],
        "OperateUin": "xx"
      }
    ],
    "RequestId": "836d7034-9854-44f0-9d4a-ee57842f8644",
    "TotalNum": 1
  }
}

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

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.
tencent
Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy