Updated on 2026-09-21 GMT+08:00

Changing the Primary Region for a Key

Change the primary region to which the key belongs. After the modification, the current region becomes the backup region.

For details, see Calling APIs.

PUT /v2/{project_id}/kms/keys/{key_id}/update-primary-region

**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
key_id	Yes	String	Definition ID of the key to be updated Constraints The value must be a 36-byte ID. The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A Default Value N/A

**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
key_id	Yes	String	Definition Key ID Constraints The value must be a 36-byte ID. The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A Default Value N/A
primary_region	Yes	String	Definition Code of the new primary region to which the key belongs, for example, cn-north-4 Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
key_id	String	Definition Key ID ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A
primary_region	String	Definition Code of the new primary region to which the key belongs, for example, cn-north-4 Range N/A

{
  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
  "primary_region" : "cn-north-4"
}

Status code: 200

Request succeeded.

{
  "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
  "primary_region" : "cn-north-4"
}

Status Code	Description
200	Request succeeded.