Updated on 2025-08-29 GMT+08:00

Updating a Custom Security Policy

Function

This API is used to update a custom security policy.

Constraints

If protocols or ciphers is updated, the modification takes effect immediately on all listeners that use the custom security policy. Updating other fields does not affect the listeners.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/elb/security-policies/{security_policy_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints: N/A

Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

Default value: N/A

security_policy_id

Yes

String

Specifies the ID of the custom security policy.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition: Specifies the token used for IAM authentication.

Constraints: N/A

Range: N/A

Default value: N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

security_policy

Yes

UpdateSecurityPolicyOption object

Definition: Specifies the request parameters for updating the custom security policy.

Constraints: N/A

Table 4 UpdateSecurityPolicyOption

Parameter

Mandatory

Type

Description

name

No

String

Definition: Specifies the name of the custom security policy.

Constraints: N/A

Range: 0 to 255 characters.

Default value: N/A

description

No

String

Definition: Specifies the description of the custom security policy.

Constraints: N/A

Range: 0 to 255 characters.

Default value: N/A

protocols

No

Array of strings

Definition: Lists the TLS protocols supported by the custom security policy.

Constraints: N/A

Range: TLSv1, TLSv1.1, TLSv1.2, and TLSv1.3.

Default value: N/A

ciphers

No

Array of strings

Definition: Lists the cipher suites supported by the custom security policy.

Constraints: The protocol and cipher suite must match. At least one cipher suite must match the protocol.

Range:

ECDHE-RSA-AES256-GCM-SHA384,ECDHE-RSA-AES128-GCM-SHA256,

ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-GCM-SHA256,

AES128-GCM-SHA256, AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256,

ECDHE-RSA-AES128-SHA256, AES128-SHA256,AES256-SHA256,

ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES256-SHA384,

ECDHE-ECDSA-AES128-SHA, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA,

ECDHE-ECDSA-AES256-SHA, AES128-SHA, AES256-SHA, CAMELLIA128-SHA,

DES-CBC3-SHA, CAMELLIA256-SHA, ECDHE-RSA-CHACHA20-POLY1305,

ECDHE-ECDSA-CHACHA20-POLY1305, TLS_AES_128_GCM_SHA256,

TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256,

TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256

Default value: N/A

NOTE:
You can match the protocol and cipher suite based on system security policy.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

security_policy

SecurityPolicy object

Specifies the custom security policy that has been updated.

request_id

String

Definition: Specifies the request ID.

Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).

Table 6 SecurityPolicy

Parameter

Type

Description

id

String

Definition: Specifies the ID of the custom security policy.

Range: N/A

project_id

String

Definition: Specifies the project ID of the custom security policy.

Range: N/A

name

String

Definition: Specifies the name of the custom security policy.

Range: N/A

description

String

Definition: Provides supplementary information about the custom security policy.

Range: N/A

listeners

Array of ListenerRef objects

Definition: Specifies the listener to be associated.

Default value: N/A

protocols

Array of strings

Definition: Lists the TLS protocols supported by the custom security policy.

ciphers

Array of strings

Definition: Lists the cipher suites supported by the custom security policy.

created_at

String

Definition: Specifies the creation time.

Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

updated_at

String

Definition: Specifies the update time.

Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

Table 7 ListenerRef

Parameter

Type

Description

id

String

Definition: Specifies the listener ID.

Range: N/A

Example Requests

Changing the TLS protocol and cipher suite used by a custom security policy

PUT https://{ELB_Endpoint}/v3/7a9941d34fc1497d8d0797429ecfd354/elb/security-policies/c73e0138-9bdc-40fb-951e-6a1598266ccd

{
  "security_policy" : {
    "name" : "update_securitypolicy",
    "protocols" : [ "TLSv1.2", "TLSv1.1", "TLSv1.3" ],
    "ciphers" : [ "CAMELLIA128-SHA", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ]
  }
}

Example Responses

Status code: 200

Successful request.

{
  "request_id" : "7fa73388-06b7-476d-9b0b-64f83de86ed4",
  "security_policy" : {
    "id" : "c73e0138-9bdc-40fb-951e-6a1598266ccd",
    "name" : "update_securitypolicy",
    "project_id" : "7a9941d34fc1497d8d0797429ecfd354",
    "description" : "",
    "protocols" : [ "TLSv1.2", "TLSv1.1", "TLSv1.3" ],
    "ciphers" : [ "CAMELLIA128-SHA", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ],
    "listeners" : [ {
      "id" : "8e92b7c3-cdae-4039-aa62-c76d09a5950a"
    } ],
    "created_at" : "2021-03-20T09:48:14Z",
    "updated_at" : "2021-03-26T01:30:31Z"
  }
}

Status Codes

Status Code

Description

200

Successful request.

Error Codes

See Error Codes.