Domain name for API request: lighthouse.intl.tencentcloudapi.com.
This API is used to create a key pair.
A maximum of 20 requests can be initiated per second for this API.
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: CreateKeyPair. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| KeyName | Yes | String | Key pair name, which can contain up to 25 digits, letters, and underscores. |
| Parameter Name | Type | Description |
|---|---|---|
| KeyPair | KeyPair | Key pair information. |
| 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. |
https://lighthouse.intl.tencentcloudapi.com/?Action=CreateKeyPair
&KeyName=test_create_1
&<Common request parameters>
{
"Response": {
"KeyPair": {
"KeyId": "lhkp-hfenegt1",
"KeyName": "test_create_1",
"PublicKey": "xxxxxx",
"AssociatedInstanceIds": [],
"CreatedTime": null,
"PrivateKey": "xxxxxx"
},
"RequestId": "02dc35eb-06f0-477f-9b06-c980bc56c18d"
}
}
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.CreateKeyPairFailed | Failed to create the key pair. |
| InvalidParameterValue.DuplicateParameterValue | The parameter KeyName already exists and is duplicate. |
| InvalidParameterValue.InvalidKeyPairNameEmpty | Invalid parametric value. |
| InvalidParameterValue.InvalidKeyPairNameIncludeIllegalChar | The key pair name is invalid. |
| InvalidParameterValue.InvalidKeyPairNameTooLong | The parameter length is invalid. |
| LimitExceeded.KeyPairLimitExceeded | The key pair quota is exceeded. |
| UnauthorizedOperation.NoPermission | No permission. |
文档反馈