Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to query and view the policy list data.
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: 2021-03-31. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Rp | No | Integer | Items per page, which should be greater than 0 and less than or equal to 200. The default value is 20. |
| Page | No | Integer | Page number, which starts from 1 and cannot exceed 200. The default value is 1. |
| Scope | No | String | Query range. Valid values: All: all policies; QCS; only preset policies; Local: only custom policies. The default value is All. |
| Keyword | No | String | Search keyword. Searches can be performed by policy name. |
| PolicyType | No | String | Policy type. Valid values: SERVICE_CONTROL_POLICY: service control policy; TAG_POLICY: tag policy. The default value is SERVICE_CONTROL_POLICY. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalNum | Integer | Total number of policies |
| List | Array of ListPolicyNode | Policy list data. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Viewing the Data of a Policy List
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListPolicies
<Common request parameters>
{
"Scope": "Local"
}
{
"Response": {
"List": [
{
"AddTime": "2022-08-04 16:04:17",
"AttachedTimes": 0,
"Description": "deny policy",
"PolicyId": 10001,
"PolicyName": "policy_name",
"Type": 1,
"UpdateTime": "2022-08-04 16:04:17"
}
],
"RequestId": "152482ca-5968-4557-ac1d-1e7ac28ce0da",
"TotalNum": 1
}
}
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 | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InterfaceNotExist | The API does not exist. |
| InvalidParameter.OrganizationMemberNotExist | The organization member does not exist. |
| InvalidParameter.OrganizationMemberNotManager | The member is not an enterprise administrator. |
| InvalidParameter.OrganizationNodeNotExist | The organization node does not exist. |
| InvalidParameter.OrganizationNotExist | Enterprise organization does not exist. |
| MissingParameter | Parameters are missing. |
| ResourceNotFound.ApplyNotExist | Application does not exist. |
| ResourceNotFound.ChangePermissionNotExist | The member permission change record does not exist. |
| ResourceNotFound.EmailBindRecordNotExist | The mailbox binding record does not exist. |
| ResourceNotFound.InvitationNotExist | Invitation message does not exist. |
| ResourceNotFound.MemberEventNotExist | The operation event does not exist. |
| ResourceNotFound.MemberIdentityNotExist | The authorizable member identity does not exist. |
| ResourceNotFound.MemberNotExist | The member does not exist. |
| ResourceNotFound.MemberOperateProcessNotExist | The member operation approval does not exist. |
| ResourceNotFound.MemberPolicyNotExist | The organization member policy does not exist. |
| ResourceNotFound.NodeNotExist | Enterprise organizational unit does not exist. |
| ResourceNotFound.NotFound | The resource does not exist. |
| ResourceNotFound.OrganizationAuthRelationNotExist | The authentication subject does not exist. |
| ResourceNotFound.OrganizationIdentityNotExist | Organization identity does not exist. |
| ResourceNotFound.OrganizationMemberNotExist | The organization member does not exist. |
| ResourceNotFound.OrganizationNodeNotExist | The organization node does not exist. |
| ResourceNotFound.OrganizationNotExist | The organization does not exist. |
| ResourceNotFound.OrganizationServiceAssignNotExist | Organization service delegation does not exist. |
| ResourceNotFound.OrganizationServiceNotExist | The organization service does not exist. |
| ResourceNotFound.PolicyIdNotFound | Policy does not exist. |
| ResourceNotFound.PolicyNotExist | Policy does not exist. |
| ResourceNotFound.ResourceTypeNotExist | The shareable resource type does not exist. |
| ResourceNotFound.ServiceRoleNotExist | The organization service role does not exist. |
| ResourceNotFound.ShareResourceMemberNotExist | The shared resource member information does not exist. |
| ResourceNotFound.UserNotExist | The user does not exist. |
| ResourceUnavailable | Resources are unavailable. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback