UpdateSecurityPolicyAttribute

Updated at:

Updates the attributes of a security policy, such as the security protocol version and cipher suite.

Operation description

Usage notes

The UpdateSecurityPolicyAttribute operation is asynchronous. After you call this operation, the system returns a request ID, but the security policy attributes are not immediately updated. The update task is still running in the background. You can call ListSecurityPolicies to query the update status of the security policy attributes:

  • If the security policy is in the Configuring state, the attributes are being updated.

  • If the security policy is in the Available state, the attributes are updated.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alb:UpdateSecurityPolicyAttribute

update

*SecurityPolicy

acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

None None

Request parameters

Parameter

Type

Required

Description

Example

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

You can generate the value from your client. Make sure that the value is unique across different requests. The ClientToken parameter supports only ASCII characters.

Note

If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.

593B0448-D13E-4C56-AC0D-FDF0F******

DryRun

boolean

No

Specifies whether to perform only a dry run. Valid values:

  • true: performs only a dry run and does not update the security policy attributes. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. If the request fails the dry run, an error is returned. If the request passes the dry run, the DryRunOperation error code is returned.

  • false (default): performs a dry run and sends the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.

true

SecurityPolicyId

string

Yes

The ID of the security policy.

sp-n0kn923****

TLSVersions

array

No

The list of supported TLS protocol versions.

string

No

The supported TLS TLS version. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, and TLSv1.3. You can specify up to four TLS TLS versions.

TLSv1.0

Ciphers

array

No

The list of supported cipher suites.

string

No

The supported cipher suite. The available cipher suites depend on the value of TLSVersions. You can specify up to 32 cipher suites.

A cipher suite is valid as long as it is supported by at least one of the specified TLSVersions.

Note

If you select TLSv1.3, the cipher suite list must include cipher suites supported by TLSv1.3.

  • Cipher suites supported by TLSv1.0 and TLSv1.1:

    • ECDHE-ECDSA-AES128-SHA

    • ECDHE-ECDSA-AES256-SHA

    • ECDHE-RSA-AES128-SHA

    • ECDHE-RSA-AES256-SHA

    • AES128-SHA

    • AES256-SHA

    • DES-CBC3-SHA

  • Cipher suites supported by TLSv1.2:

    • ECDHE-ECDSA-AES128-SHA

    • ECDHE-ECDSA-AES256-SHA

    • ECDHE-RSA-AES128-SHA

    • ECDHE-RSA-AES256-SHA

    • AES128-SHA

    • AES256-SHA

    • DES-CBC3-SHA

    • ECDHE-ECDSA-AES128-GCM-SHA256

    • ECDHE-ECDSA-AES256-GCM-SHA384

    • ECDHE-ECDSA-AES128-SHA256

    • ECDHE-ECDSA-AES256-SHA384

    • ECDHE-RSA-AES128-GCM-SHA256

    • ECDHE-RSA-AES256-GCM-SHA384

    • ECDHE-RSA-AES128-SHA256

    • ECDHE-RSA-AES256-SHA384

    • AES128-GCM-SHA256

    • AES256-GCM-SHA384

    • AES128-SHA256

    • AES256-SHA256

    • ECDHE-RSA-CHACHA20-POLY1305

    • ECDHE-ECDSA-CHACHA20-POLY1305

  • Cipher suites supported by TLSv1.3:

    • 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

ECDHE-ECDSA-AES128-SHA

SecurityPolicyName

string

No

Policy Name of the security policy.

Policy Name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), hyphens (-), and spaces. It must start with a letter, Chinese character, or digit.

test-secrity

Response elements

Element

Type

Description

Example

object

The response structure.

JobId

string

The ID of the asynchronous task.

72dcd26b-f12d-4c27-b3af-18f6aed5****

RequestId

string

The ID of the request.

593B0448-D13E-4C56-AC0D-FDF0******

Examples

Success response

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "593B0448-D13E-4C56-AC0D-FDF0******"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IncorrectStatus.SecurityPolicy The status of %s [%s] is incorrect. The status of %s [%s] is incorrect.
404 ResourceNotFound.SecurityPolicy The specified resource %s is not found. The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.