- 动态与公告
- 产品简介
- 购买指南（已停售）
- 快速入门
- 操作指南
- 插件使用
- 实践教程
- 从 A 地域迁移到 B 地域
- 开发指南
- API 文档
- 历史功能
- 常见问题
- 服务等级协议
- 联系我们
- 词汇表
- 动态与公告
- 产品简介
- 购买指南（已停售）
- 快速入门
- 操作指南
- 插件使用
- 实践教程
- 从 A 地域迁移到 B 地域
- 开发指南
- API 文档
- 历史功能
- 常见问题
- 服务等级协议
- 联系我们
- 词汇表
1. API Description
Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to create an API key pair.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateApiKey. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-08. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SecretName | Yes | String | Custom key name. |
| AccessKeyType | No | String | Key type. Valid values: auto, manual (custom key). Default value: auto. |
| AccessKeyId | No | String | Custom key ID, which is required if AccessKeyType is manual. It can contain 5-50 letters, digits, and underscores. |
| AccessKeySecret | No | String | Custom key, which is required if AccessKeyType is manual. It can contain 10-50 letters, digits, and underscores. |
| Tags.N | No | Array of Tag |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Result | ApiKey | New key details. Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 CreateApiKey
Input Example
https://apigateway.tencentcloudapi.com/?Action=CreateApiKey
&SecretName=test
&<Common request parameters>
Output Example
{
"Response": {
"Result": {
"AccessKeyId": "AKID***********************************************",
"AccessKeySecret": "************************************",
"AccessKeyType": "auto",
"SecretName": "test",
"Status": 1,
"CreatedTime": "2020-02-26T06:10:01Z",
"ModifiedTime": "2020-02-26T06:10:01Z"
},
"RequestId": "ad5218b4-edc3-4195-ba4d-a0ef176783ba"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.AccessKeyExist | The custom key already exists. |
| InternalError.ApigwException | API Gateway internal request error. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket. |
| InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| LimitExceeded.ApiKeyCountLimitExceeded | The number of keys exceeds the limit. |
| UnauthorizedOperation.UncertifiedUser | The user has not passed identity verification. |
| UnsupportedOperation.UnpackError |
是
否
本页内容是否解决了您的问题？