You need to enable JavaScript to run this app.
文档中心
密钥管理系统

密钥管理系统

复制全文
下载 pdf
密钥管理
UpdatePrimaryRegion - 更新密钥主地域
复制全文
下载 pdf
UpdatePrimaryRegion - 更新密钥主地域

调用本接口更新多地域密钥的主地域,用于调整多地域密钥的主从关系。

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

UpdatePrimaryRegion

要执行的操作,取值:UpdatePrimaryRegion。

Version
String
是

2021-02-18

API的版本,取值:2021-02-18。

KeyringName
String
否

test

密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。可通过 CreateKeyring 创建密钥环时指定,或通过 DescribeKeyrings、QueryKeyring 查询获取。当不指定 KeyID 时,必须与 KeyName 同时传入;与 KeyID 二选一。

KeyName
String
否

mrk-test

主密钥名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。可通过 CreateKey 创建密钥时指定,或通过 DescribeKeys、DescribeKey 查询获取。当不指定 KeyID 时,必须与 KeyringName 同时传入;与 KeyID 二选一。

KeyID
String
否

39a0e7c6-b7dd-4c83-b400-3449bb95403a

主密钥 ID,UUID 形式。可通过 CreateKey 创建密钥时返回,或通过 DescribeKeys、DescribeKey 查询获取。KeyID 与 KeyringName + KeyName 二选一;传入 KeyID 时无需传入 KeyringName 和 KeyName;未传入 KeyID 时,必须同时传入 KeyringName 和 KeyName。

PrimaryRegion
String
是

cn-shanghai

新的主地域 ID。可通过 DescribeRegions 接口查询支持的地域 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdatePrimaryRegion&Version=2021-02-18 HTTP/1.1
Host: kms.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241219T132836Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "KeyringName": "test",
  "KeyName": "mrk-test",
  "PrimaryRegion": "cn-shanghai"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024121921284211621508106533A0BE",
    "Action": "UpdatePrimaryRegion",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidOperation

The request was rejected because the specified resource is not valid for this operation.

指定资源或当前状态不支持该操作,请确认操作对象和调用时机。

400
InvalidKeyStatus

Current key status: %s does not allow to perform this action

当前密钥状态不支持执行该操作,请检查密钥是否处于接口要求的状态。

400
InvalidParameter

The request parameter %s is invalid.

请求参数格式、类型或取值不合法,请根据参数说明检查并修正请求。

403
AccessDenied

User is not authorized to do this action

当前账号或子账号缺少执行该操作所需权限,请检查 IAM 授权策略。

403
Reject.Throttling.Action

The request of Action: %s upper limit is exceeded.

接口级请求频率超过限制,请降低请求速率后重试。

404
Not Found

Not found %s [%s].

指定资源不存在或当前账号无权访问,请检查资源 ID、名称和地域是否正确。

500
UndefinedError

Undefined Internal Error. Pls Contact With Admin.

服务内部错误,请稍后重试;如持续出现,请联系技术支持。

最近更新时间:2026.09.03 18:00:33
这个页面对您有帮助吗?
有用
有用
无用
无用