文档中心

获取主备鉴权Key

最近更新时间：2024.01.31 14:58:29

首次发布时间：2021.02.23 10:42:23

本接口支持通过输入服务 ID 获取服务的主备鉴权信息。

请求说明

接口名称：GetImageAuthKey
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageAuthKey&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必填描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

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

ServiceId

String

是

服务 ID。

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

返回参数

参数	类型	描述
ServiceId	String	指定的服务 ID。
PrimaryKey	String	该服务的主鉴权 Key。
SecondaryKey	String	该服务的备鉴权 Key。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAuthKey&Version=2018-08-01&ServiceId=fc51f8f9*

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageAuthKey",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceId":"d7b8****ff3c",
        "PrimaryKey": "abcd****nopq",
        "SecondaryKey": "tsrq****jihgf"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageAuthKey",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "Code": "RetrieveAuthKeyFailure",
            "Message": "Service not found."
        }
    }
}

错误码

访问公共错误码和服务相关错误码获取详细信息。