更换密钥

最近更新时间:2019-05-20 17:16:45

接口描述

本接口(UpdateApiKey)用于更换用户已创建的一对 API 密钥。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数

参数名称 是否必选 类型 描述
secretId String 待更换的密钥 ID。
secretKey String 待更换的密钥 Key,更新自定义密钥时,该字段为必传。长度10 - 50字符,包括字母、数字、英文下划线。

说明:

secretKey 在更换自定义密钥时填写,若是自动生成的密钥不需要填写此字段,若在创建时是自定义密钥,请确认您已开通白名单。您可联系客户经理或 提交工单 申请开通白名单。

输出参数

参数名称 类型 描述
code Int 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
codeDesc String 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因。
message String 模块错误信息描述,与接口相关。
secretId String 待更换的密钥 ID。
secretKey String 更换后的密钥 Key。
type String 密钥类型。
modifiedTime Timestamp 更换时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

示例

示例一

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=UpdateApiKey
&secretId=AKIDXXXXWKipDlK

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "secretId": "AKIDXXXXWKipDlK",
    "secretKey": "adasfdasffa",
    "type": "auto",
    "modifiedTime": "2017-08-07T00:00:00Z"
}

示例二

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=UpdateApiKey
&secretId=myTestSecretId
&secretKey= myTestSecretKey

返回示例如下:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success",
    "secretId": "myTestSecretId",
    "secretKey": "myTestSecretKey",
    "type": "manual",
    "modifiedTime": "2017-08-07T00:00:00Z"
}