跳到主要内容

查詢金鑰對

描述

查詢一條或者多條金鑰對資訊,可以根據名稱查詢。

請求引數

引數名引數型別是否必填引數說明
ActionString操作方法:DescribeKeyPairs
RegionString機房標識,取值參見地域列表
OffsetInteger記錄偏移量,不指定取 0
CountString記錄數量,不指定為全部
Id.NString金鑰id,支援批次,N為自然數,格式:&Id.0=xxx&Id.1=xxx等
Name.NString名稱,支援批次,N為自然數,格式:&Name.0=xxx&Name.1=xxx等

返回引數

名稱型別說明
ActionString執行的操作
TaskIdString請求標識
TotalCountInteger過濾條件下總共記錄數
KeyPairSetKeyPairSetItemType由KeyPairSetItemType組成的陣列格式,返回金鑰對的資訊

KeyPairSetItemType

金鑰對資訊的資料型別

名稱型別說明
IdString金鑰對標識
NameString金鑰對名稱
EncryptionString加密方式
KeyPasswordStringkey密碼
DescriptionString描述
PublicKeyString公鑰
PrivateKeyString私鑰
CreateTimeDateTime建立時間

請求示例

https://api.yunpanel.com/v2/?Action=DescribeKeyPairs
&Region=cn-wuxi1
&AccessKeyId=6792aa42d288422ab8dd4654dfe727c4
&Count=15
&Id.0=sk-wl8hh7mdrn96u
&Offset=1
&公共引數

返回示例

{ "code": 10000, "message": "", "data": ```

{
"TaskId": "8k28h20170829093741490",
"Action": "DescribeKeyPairs",
"TotalCount": 1,
"KeyPairSet": [
{
"Id": "sk-wl8hh7mdrn96u",
"Name": "新的金鑰對",
"Encryption": null,
"KeyPassword": null,
"Description": null,
"PublicKey": "ssh-rsa
AAAAB3NzaC1yc2EAAAADAQABAAABAQCaBtk1CQJFwijcZ60wkmpvQp3kGHYWQxkK2iuhJK2nsCyWlJetYRGId+OROF+GigZTO/dIjprBEs7iITQyFp1JqtF2AzGkRGgLGXO8E1dwEuLXAWi/hUKs34J+4S1liCQkD5TM/lWxrQ4v6nEqlbvQflWPuY2EtwsP/KfV824sz7OJiY9d3AQ5n+0zIDczQA1OMjnaUOfzPn6+tmcpgk4U4w1Xgbh7JrVantxMC5iGDexl4y0ZcTEzIqh9m+VUcDt3iTA/rJQmw+jyNm+772qd8ZEoLvr5uZnSHtGY6174ZzStZF7+mY7Qi9dLKZLNltwVU6Zeus7a1vVtDVlRimsr",
"PrivateKey": null,
"CreateTime": "2017-08-22T13: 27: 59 +0800"
}
]
}

}