Copying a Policy Group

Function

This API is used to copy a policy group. You can copy an existing premium or container edition policy group to create a new one.

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, no identity policy-based permission required for calling this API.

URI

PUT /v5/{project_id}/policy/group

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Definition Description of a policy group Constraints N/A Range Length: 1 to 64 characters. The value can contain only letters, numbers, commas (,), periods (.), spaces, underscores (_), and hyphens (-). Default Value N/A
name	Yes	String	Definition Policy group name. Constraints N/A Range Length: 1 to 32 characters. The value can contain only letters, numbers, commas (,), periods (.), spaces, underscores (_), and hyphens (-), and cannot start with default_policy_group. Default Value N/A
group_id	Yes	String	Definition ID of the policy group to be copied. Only premium and container edition policy groups can be copied. Constraints You need to use the ListPolicyGroup API to query premium and container edition policy groups. In the response body of the ListPolicyGroup API, the group_id whose support_version is hss.version.container.enterprise or hss.version.premium is the ID of the policy group that can be copied. Range 36 to 64 characters Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Copy a policy group. Select an existing premium or container edition policy group and copy it to create a new one.

PUT https://{endpoint}/v5/{project_id}/policy/group

{
  "description" : "description",
  "name" : "policy_group_name",
  "group_id" : "f1a342a1-0e6e-3dd9-94b6-a73717d7b72c"
}