Updating a Security Group Policy

Function

This API is used to update a security group policy (for the cloud native network model).

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}/container-network/{cluster_id}/{namespace}/security-group-policy

**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
cluster_id	Yes	String	Definition Unique ID of the Kubernetes cluster, which is used to specify the cluster that the security group policy to be updated belongs to. Constraints Ensure that the cluster has been connected to HSS and that the account has the operation permission on the cluster. Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). Default Value None
namespace	Yes	String	Definition Namespace ID in the Kubernetes cluster, which is used to isolate security group policies in different namespaces. Constraints The namespace must exist in the specified cluster. Otherwise, an error will be returned, indicating that the resource does not exist. Range The value is a string of 1 to 63 characters, including letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-). Default Value None

**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
policy_id	Yes	String	Definition Unique ID of the security group policy, which is used to specify the target security group policy to be updated. Constraints The policy must exist in the specified cluster and namespace. Otherwise, an error will be returned, indicating that the policy does not exist. Range The value contains 1 to 64 characters and can be in UUID format (32 hexadecimal characters, including four hyphens [-]). Default Value None
policy_name	No	String	Definition Name of the security group policy, which is used to identify the policy purpose. The name can be changed during update. Constraints The name cannot contain special characters (example: @#$). You are advised to set a policy name that is unique in a namespace. Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). Default Value None. Do not modify the policy name.
security_groups	Yes	Array of SecurityGroup objects	Definition The security group set to be associated with the security group policy. After the update, the policy applies only to the security groups in the list. Constraints The array cannot be empty (at least one security group is required), and the security group must exist in the current project or enterprise project. Range The array can contain 1 to 20 elements. Each element must comply with the SecurityGroup object structure. Default Value None

**Table 5** SecurityGroup
Parameter	Mandatory	Type	Description
security_group_id	Yes	String	Definition Unique ID of a security group in the cloud native network model, which is used to associate a specific security group with a policy. Constraints The security group must be in the same VPC network as the cluster. Otherwise, the association fails. Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). Default Value None
security_group_name	No	String	Definition Name of a security group. Constraints If this parameter is specified, its value must be the same as the name of the security group corresponding to security_group_id. Otherwise, the display may be abnormal. (Functions are not affected.) Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). Default Value None. By default, the system name corresponding to the security group ID is used.
security_group_description	No	String	Definition Description of the security group, which is used to record the purpose and permission scope of the security group. Constraints The description cannot contain special characters such as HTML tags. Range The value can contain 0 to 256 characters, including Chinese characters, letters, numbers, common punctuations, and spaces. Default Value None. Do not modify the security group description. (If the original description is empty, keep it empty).

Response Parameters

Status code: 200

After the API update succeeds, no data is returned. Only the status code 200 is returned, indicating that the update is successful. If the update fails, the corresponding error code and error information is returned. For details, see "Error Codes".

None

Example Requests

This API is used to update a security group policy (for the cloud native network model).

PUT https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/{namespace}/security-group-policy?enterprise_project_id=all_granted_eps

{
  "policy_id" : "501830f7-a182-41ea-a9ae-10973410eca6",
  "policy_name" : "ywk-test",
  "security_groups" : [ {
    "security_group_id" : "090cef69-1b90-4f86-9e10-ba593811fcf4",
    "security_group_name" : "sg-df44"
  }, {
    "security_group_id" : "110a7b73-7fae-4c28-bae8-535f6a853613",
    "security_group_name" : "hss-test-block"
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
200	After the API update succeeds, no data is returned. Only the status code 200 is returned, indicating that the update is successful. If the update fails, the corresponding error code and error information is returned. For details, see "Error Codes".