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.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: CreateApiKey. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-08-08. |
| Region | Yes | String | Common parameter. 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. |
| 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, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=CreateApiKey
&SecretName=test
&<Common request parameters>{
"Response": {
"Result": {
"AccessKeyId": "AKID8my5MRr9i6VM98F3dZG9zV0KuBq5ID7pMG83",
"AccessKeySecret": "9i3BQU8lMUl2dAvrF8RvL5EM6RKEG47P770du61B",
"AccessKeyType": "auto",
"SecretName": "test",
"Status": 1,
"CreatedTime": "2020-02-26T06:10:01Z",
"ModifiedTime": "2020-02-26T06:10:01Z"
},
"RequestId": "ad5218b4-edc3-4195-ba4d-a0ef176783ba"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.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. |
Was this page helpful?