Docs
api
UHost(UHost)
CreateUHostKeyPair

Create Host Key Pair - CreateUHostKeyPair

Overview

Create Host Key Pair Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateUHostKeyPair.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesNo
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
KeyPairNamestringKey pair name. Composed of letters, numbers, and symbols, with a length of 1-63 characters.Yes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
KeyPairKeyPairKey InformationYes

Data Model

KeyPair

Field NameTypeDescription InformationRequired
ProjectIdstringProject ID.No
KeyPairIdstringKey Pair ID.No
KeyPairNamestringKey pair name. The length is 1~63 English or Chinese characters.No
KeyPairFingerPrintstringKey Pair Fingerprint. md5(ProjectId|KeyPairId|PublicKey)No
PrivateKeyBodystringThe content of the private key in the key pair. Only the creation interface will return this.No
CreateTimeintThe creation time of the key pair, in Unix Timestamp format.No

Example

Request Example

https://api.ucloud-global.com/?Action=CreateUHostKeyPair
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=EmINSQAU
&KeyPairName=IqZZckdR

Response Example

{
  "Action": "CreateUHostKeyPairResponse",
  "KeyPairName": "bRkLZgiA",
  "RetCode": 0
}