文档中心

获取主备鉴权 Key

最近更新时间：2024.04.30 11:32:45

首次发布时间：2024.04.30 11:32:45

本接口支持获取指定服务 ID 配置的主备鉴权信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

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

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

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

ServiceId

String

是

y7****w7

服务 ID。

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ServiceId	String	`y7****w7`	指定的服务 ID。
PrimaryKey	String	`hi2d8h***e6td2h`	该服务的主鉴权 Key。
SecondaryKey	String	`8uw19***e1guw80`	该服务的备鉴权 Key。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAuthKey&Version=2023-05-01&ServiceId=y7****w7

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageAuthKey",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId": "y7****w7",
        "PrimaryKey": "hi2d8h***e6td2h",
        "SecondaryKey": "8uw19***e1guw80"
    }
}

错误码

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

SDK

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