Querying Policy Templates

Function

This interface is used to query the brief information list of a policy template, including the policy information and application object information. When creating a policy group, you can adjust the configuration based on the existing policy template to quickly create a policy group.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:policyGroups:listTemplate

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:policyGroups:listTemplate	List	-	-	-	-

URI

GET /v1/{project_id}/policy-templates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query offset
limit	No	Integer	Number of records to be queried. Range: 1 to 100.
policy_group_name	No	String	Filters results based on the policy template name.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total
items	Array of PolicyGroupForTemplate objects	Policy group list. The maximum number of returned items is the maximum number of records on each page.

**Table 5** PolicyGroupForTemplate
Parameter	Type	Description
id	String	Unique policy group ID.
name	String	Policy group name.
priority	Integer	Priority.
description	String	Server group description.
create_time	String	Time when a policy group was created.
update_time	String	Time when a policy group was updated.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

GET /v1/089b2f9a3d80d3062f24c00ca4ed5cbd/policy-templates

Example Responses

Status code: 200

Response to the request for querying policy template information.

{
  "count" : 2,
  "items" : [ {
    "id" : "572947120093396992",
    "name" : "test0001",
    "priority" : 0,
    "description" : "test0001",
    "create_time" : "2023-05-29T07:39:50.509Z",
    "update_time" : "2023-05-29T07:39:50.509Z"
  }, {
    "id" : "572944657261002752",
    "name" : "tsfasdfas",
    "priority" : 0,
    "description" : "",
    "create_time" : "2023-05-29T07:30:03.324Z",
    "update_time" : "2023-05-29T07:30:03.324Z"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying policy template information.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	Permissions required.
404	No resources found.
405	The request method is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.

Error Codes

See Error Codes.

Parent topic: Policy Management

Previous topic: Adding a Policy Template

Next topic: Modifying a Policy Template

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot