CAM Overview
Features
Scenarios
Basic Concepts
Use Limits
User Types
Domain name for API request: cam.intl.tencentcloudapi.com.
This API is used to query the policy list.
A maximum of 20 requests can be initiated per second for this API.
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: ListPolicies. |
| 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. |
| Rp | No | Integer | Number of entries per page: must be greater than 0 and no greater than 200. Default is 20 |
| Page | No | Integer | Page number. Starts from 1 and cannot be greater than 200. Default is 1 |
| Scope | No | String | Valid values: All, QCS, and Local. All means all policies will be returned; QCS means only preset policies will be returned; Local means only custom policies will be returned. All is the default value |
| Keyword | No | String | Filter by policy name |
| Parameter Name | Type | Description |
|---|---|---|
| TotalNum | Integer | Total number of policies |
| List | Array of StrategyInfo | Policy array. Each array contains fields including policyId, policyName, addTime, type, description, and createMode. policyId: policy ID policyName: policy name addTime: policy creation time type: 1: custom policy, 2: preset policy description: policy description createMode: 1 indicates a policy created based on business permissions, while other values indicate that the policy syntax can be viewed and the policy can be updated using the policy syntax Attachments: number of associated users ServiceType: the product the policy is associated with IsAttached: this value should not be null when querying if a marked entity has been associated with a policy. 0 indicates that no policy has been associated, and 1 indicates that a policy has been associated |
| ServiceTypeList | Array of String | Reserved field 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. |
POST / HTTP/1.1
Host: cam.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListPolicies
<Common request parameters>
{
"Rp": "1",
"Page": "10"
}{
"Response": {
"ServiceTypeList": [
"xx"
],
"List": [
{
"PolicyId": 16313162,
"PolicyName": "QcloudAccessForCDNRole",
"AddTime": "2019-04-19 10:55:31",
"Type": 2,
"Description": "Tencent Cloud Content Delivery Network (CDN) permissions include CRUD operations for CLS logsets and log topics as well as searching for, downloading, and uploading logs.",
"CreateMode": 2,
"Attachments": 0,
"ServiceType": "cooperator",
"IsAttached": 1,
"Deactived": 1,
"DeactivedDetail": [
"cvm"
],
"IsServiceLinkedPolicy": 1
"UpdateTime": "2019-04-19 10:55:31",
"AttachEntityCount": 0,
"AttachEntityBoundaryCount": 0
}
],
"TotalNum": 239,
"RequestId": "ae2bd2b7-1d55-4b0a-8154-e02407a2b390"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.GroupIdError | GroupId field invalid. |
| InvalidParameter.KeywordError | Keyword field invalid. |
| InvalidParameter.ParamError | Invalid input parameter. |
| InvalidParameter.ScopeError | Scope field invalid. |
| InvalidParameter.SearchKeywordLengthError | An error occurred while querying the keyword length. |
| InvalidParameter.ServiceTypeError | ServiceType field invalid. |
| InvalidParameter.UinError | Uin field invalid. |
피드백