创建密钥
最近更新时间: 2024-10-18 10:38:32
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（CreateApiKey）用于创建一对新的 API 密钥。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-11-24 14:50:53。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateApiKey |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| SecretName | 是 | 否 | String | 用户自定义密钥名称。 |
| AccessKeyType | 否 | 否 | String | 密钥类型，支持 auto 和 manual（自定义密钥），默认为 auto。 |
| AccessKeyId | 否 | 否 | String | 用户自定义密钥 ID，AccessKeyType 为 manual 时必传。长度为5 - 50字符，由字母、数字、英文下划线组成。 |
| AccessKeySecret | 否 | 否 | String | 用户自定义密钥 Key，AccessKeyType 为 manual 时必传。长度为10 - 50字符，由字母、数字、英文下划线。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | ApiKey | 新增的密钥详情。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.FormatError | |
| LimitExceeded.ApiKeyCountLimitExceeded | |
| InternalError.OssException | |
| FailedOperation.AccessKeyExist |