DescribeKeyPairs - - Alibaba Cloud Documentation Center

Menanyakan satu atau beberapa pasangan kunci.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kemudahan Anda, disarankan memanggil operasi ini di OpenAPI Explorer, yang secara dinamis menghasilkan contoh kode untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeKeyPairs	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeKeyPairs.
RegionId	String	Yes	cn-hangzhou	ID Wilayah dari pasangan kunci. Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar wilayah terbaru.
KeyPairName	String	No	SshKey	Nama pasangan kunci. Anda dapat menggunakan simbol asterisk () sebagai wildcard dalam ekspresi reguler untuk melakukan pencarian fuzzy terhadap pasangan kunci. Pola contoh: `SshKey`: menanyakan pasangan kunci yang namanya diakhiri dengan SshKey, termasuk pasangan kunci bernama SshKey. `SshKey`: menanyakan pasangan kunci yang namanya diawali dengan SshKey, termasuk pasangan kunci bernama SshKey. `SshKey*`: menanyakan pasangan kunci yang namanya mengandung SshKey, termasuk pasangan kunci bernama SshKey. `SshKey`: menanyakan pasangan kunci bernama SshKey.
KeyPairFingerPrint	String	No	ABC1234567	Sidik jari pasangan kunci. Algoritma message-digest 5 (MD5) digunakan berdasarkan format sidik jari kunci publik yang didefinisikan dalam RFC 4716. Untuk informasi lebih lanjut, lihat RFC 4716.
PageNumber	Integer	No	1	Nomor halaman yang dikembalikan. Halaman dimulai dari halaman 1. Nilai default: 1.
PageSize	Integer	No	10	Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 50. Nilai default: 10.
ResourceGroupId	String	No	rg-amnhr7u7c7hj****	ID kelompok sumber daya. Jika parameter ini ditentukan untuk menanyakan resource, respons dapat menampilkan hingga 1.000 resource yang termasuk dalam kelompok sumber daya tersebut. Catatan Resource dalam kelompok sumber daya default akan selalu ditampilkan dalam respons, terlepas dari pengaturan parameter ini.
Tag.N.Key	String	No	TestKey	Kunci tag N dari pasangan kunci. Nilai valid untuk N: 1 hingga 20. Jika satu tag ditentukan untuk menanyakan resource, respons dapat menampilkan hingga 1.000 resource yang terikat dengan tag tersebut. Jika beberapa tag ditentukan untuk menanyakan resource, respons dapat menampilkan hingga 1.000 resource yang terikat dengan semua tag tersebut. Untuk menanyakan lebih dari 1.000 resource yang memiliki tag tertentu, panggil operasi ListTagResources.
Tag.N.Value	String	No	TestValue	Nilai tag N dari pasangan kunci. Nilai valid untuk N: 1 hingga 20.

Parameter respons

Parameter	Type	Example	Description
PageSize	Integer	10	Jumlah entri yang dikembalikan per halaman.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID permintaan.
PageNumber	Integer	1	Nomor halaman yang dikembalikan.
TotalCount	Integer	1	Jumlah total pasangan kunci.
KeyPairs	Array of KeyPair		Detail mengenai pasangan kunci.
KeyPair
CreationTime	String	2023-09-04T08:33Z	Waktu saat pasangan kunci dibuat.
KeyPairName	String	testKeyPairName	Nama pasangan kunci.
KeyPairFingerPrint	String	ABC1234567	Sidik jari pasangan kunci.
ResourceGroupId	String	rg-amnhr7u7c7hj****	ID kelompok sumber daya.
Tags	Array of Tag		Tag dari pasangan kunci.
Tag
TagValue	String	TestValue	Nilai tag dari pasangan kunci.
TagKey	String	TestKey	Kunci tag dari pasangan kunci.

Contoh

Contoh permintaan

https://ecs.aliyuncs.com/?Action=DescribeKeyPairs
&RegionId=cn-qingdao
&KeyPairFingerPrint=ABC1234567
&KeyPairName=SshKey
&PageNumber=1
&PageSize=20
&<Common request parameters>

Contoh respons sukses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeKeyPairsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <KeyPairs>
        <KeyPair>
            <CreationTime>2023-09-04T08:33Z</CreationTime>
            <ResourceGroupId/>
            <KeyPairName>testKeyPairName</KeyPairName>
            <KeyPairFingerPrint>ABC1234567</KeyPairFingerPrint>
        </KeyPair>
    </KeyPairs>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DescribeKeyPairsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "PageSize" : 2,
  "TotalCount" : 1,
  "KeyPairs" : {
    "KeyPair" : [ {
      "CreationTime" : "2023-09-04T08:33Z",
      "ResourceGroupId" : "",
      "KeyPairName" : "testKeyPairName",
      "KeyPairFingerPrint" : "ABC1234567"
    } ]
  },
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Kode kesalahan

For a list of error codes, visit the API Error Center.