Query Host Key Information - DescribeUHostKeyPairs

Overview

Query one or more key pairs.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUHostKeyPairs`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	No
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
KeyPairName	string	Key Pair Name.	No
KeyPairFingerPrint	string	Fingerprint of the key pair.	No
Offset	int	List start position offset, default is 0	No
Limit	int	Return data length, default is 20, maximum 100	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
KeyPairs	array[KeyPairDesc]	Key Pair Information Set	Yes
TotalCount	int	Total Number of Key Pairs	Yes

Data Model

KeyPairDesc

Field Name	Type	Description Information	Required
ProjectId	string	Project ID.	No
KeyPairId	string	Key Pair ID.	No
KeyPairName	string	Key pair name. The length is 1~63 English or Chinese characters.	No
KeyPairFingerPrint	string	Key Pair Fingerprint. md5(ProjectId\|KeyPairId\|PublicKey)	No
CreateTime	int	The creation time of the key pair, in Unix Timestamp format.	No

Example

Request Example


https://api.surfercloud.com/?Action=DescribeUHostKeyPairs
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=hHjwEGLs
&KeyPairName=BTpJhjPo
&KeyPairFingerPrint=KEhDIIJf
&Offset=7
&Limit=2

Response Example


{
  "Action": "DescribeUHostKeyPairsResponse",
  "KeyPairs": [
    {
      "CreateTime": "SbXyAFFW",
      "KeyPairFingerPrint": "hDSGSuhK",
      "KeyPairId": "ZBIzfUoy",
      "KeyPairName": "wMJeFQGOjhlyFbvYAGKSysoELNdTbOpeOkABtyxTKfGyheuMVDXxlIVbZDBGXdWoyvkfxaOJLtncqcRWZxLBlEvflSQRyLMofalkxFrSpUmomhMqfjUAyjPyRARVhGfwOEoABifOjGJKzDPtObsplwjWbCNMpqsVAJdfUotcPmrbMtFyOpbBSSSvJvuvgGVjkQoeYqpQAlIAIrFcjOfnFFBzSfSdhPDQEFVxjBcvryrPIeheyjPzXzcEtpqaprwEEAZpxRHynQDCzClDSjMKKDRokbYgTHGgxMxCXMbuigMNjxBoCmKqOzpfSvEXtNXRKOttlgmNnjpLARpNbJxgjxxnbOQiuUFwmRecstEQtezDWrmNQVxZCBBwPJwjVUmNRMoxTTSLixrmBSuTFKXsVAPpwsuGjMoeBDkJAPgzofGRglGpzMJtGKQzeXxqiqQqeDLsBlHFsAYIMpTdEYLhpEKDFrNtbkciavzzsVMCScWUslsNGlOtuSvsrNUBwJnsGkkbBTXNFSYxdHhAodHqrHThejtJPhVXYmvPFHhdnVRVGWxcoXaVBCUhfIboQfAkUxYOJIMYDBzyjgskYOdENYWotJuseLCCaEDWkQityNfuDWQZquvsaoXSYBnqzsSYGzgMVTYLRiiBpXInSavylybdJFgfXQkumPLhUtWRKfgIGsxoGgziwpcuDGfSyHEhznvhucqACsPExdXVFMRRJlBRYMJkgLrhEMhJBkDUVrUPfCZCHjggFSIATcfrzyUdSPnlwiKPeGdqULpprZJHAaEOvEzAFJgJfSFgEdlhrynPwNsEOIdJboDPyunlvIIoxdDJEbxrQNPxLWCFxmCQcLzGQIoTybUwflqreZgNoSeEvVxtTIAdYvGviOKoQBigFFSpzxBDodUbZVBhnOSrLpeiAneGHzFRlCfrFPGlwXqwwoMXdCfXnibPmHXfJEUYdBTKLEwYJJnALUTGALSRpSyxMQjLqaYWTdewJLAiEkPJqRhlIiCchoMuoTpFTwyKQuALthtYHNIljMPbJmszPZxOQRrScCsSQMmMqaBI",
      "ProjectId": "KVBmLnkb"
    }
  ],
  "RetCode": 0,
  "TotalCount": 9
}