更新主备鉴权 Key--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新主备鉴权 Key

最近更新时间：2024.08.13 20:23:51首次发布时间：2024.04.30 11:32:45

本接口支持更新指定服务 ID 下的主备鉴权 Key，来修改鉴权信息。

注意事项

请求频率限制：单用户请求频率限制为 10 次/秒。
超时时间：约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=UpdateImageAuthKey&Version=2023-05-01

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 UpdateImageAuthKey 接口名称。当前 API 的名称为 UpdateImageAuthKey。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageAuthKey`	接口名称。当前 API 的名称为 `UpdateImageAuthKey`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`2y***s2`	待更新配置的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

2y***s2

待更新配置的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
PrimaryKey	String	否	`899z09z***121u2e9w`	主鉴权 key，长度为 8-32 字节，为空则不更新主鉴权值。
SecondaryKey	String	否	`030fwe8***j9wqhiqs`	备鉴权 key，长度为 8-32 字节，为空则不更新备鉴权值。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageAuthKey&Version=2023-05-01&ServiceId=2y***s2
{
    "PrimaryKey": "899z09z***121u2e9w",
    "SecondaryKey": "030fwe8***j9wqhiqs"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageAuthKey",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 UpdateImageAuthKey 接口文档现已停止维护，建议您参考本文档使用最新版本。