创建密钥

最近更新时间:2019-05-20 17:28:24

接口描述

本接口(CreateApiKey)用于创建一对新的 API 密钥。

输入参数

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

参数名称 是否必选 类型 描述
secretName String 用户自定义密钥名称。
secretId String 用户自定义密钥 ID,type 为 manual 时必传。长度为5 - 50字符,由字母、数字、英文下划线组成。
secretKey String 用户自定义密钥 Key,type 为 manual 时必传。长度为10 - 50字符,由字母、数字、英文下划线。
type String 密钥类型,支持 auto 和 manunal(自定义密钥),默认为 auto。

说明:

type 等于 manunal(自定义密钥 )是内测类型,目前需要开通白名单,您可联系客户经理或 提交工单 申请开通白名单。

输出参数

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

示例

示例一

https://apigateway.api.qcloud.com/v2/index.php?
&<公共请求参数>
&Action=CreateApiKey
&secretName=myTest

返回示例如下:

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

示例二

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

返回示例如下:

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