Updated on 2026-08-25 GMT+08:00

Updating a Key Policy

Function

This API is used to update a key policy.

Calling Method

For details, see Calling APIs.

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

    kms:policy:update

    Write

    policy *

    -

    -

    -

URI

PUT /v1.0/{project_id}/kms/key-policies/{policy_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

policy_id

Yes

String

Definition

Key policy ID

Constraints

N/A

Range

The value must be in UUID format consisting of 36 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

policy

Yes

String

Definition

Modified key policy

Constraints

The value must be a converted JSON string.

Range

N/A

Default Value

N/A

description

No

String

Definition

Key policy description

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

policy_id

String

Definition

Key policy ID

Range

N/A

policy

policy object

Definition

Key policy

Range

N/A

description

String

Definition

Key policy description

Range

N/A

last_modify_time

String

Definition

Last update time of the key policy

Range

N/A

Table 5 policy

Parameter

Type

Description

version

String

Key policy version

validity_period

validity_period object

Key policy validity period

allowed_access_point

Array of strings

Allowed access point ID list

allowed_data_security_zone

Array of strings

Allowed data security zone ID list

Table 6 validity_period

Parameter

Type

Description

start_time

String

Effective time of a key policy

end_time

String

Key policy expiration time

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.