AttachKeyPair - Elastic Compute Service - Alibaba Cloud Documentation Center

Menyambungkan pasangan kunci SSH ke satu atau beberapa instans Linux.

Deskripsi operasi

Saat memanggil operasi ini, perhatikan hal-hal berikut:

Instans Windows tidak mendukung pasangan kunci SSH.
Setelah Anda menyambungkan pasangan kunci SSH, otentikasi menggunakan nama pengguna dan kata sandi dinonaktifkan.
Jika instans berada dalam status Running, mulai ulang instans dengan memanggil RebootInstance agar pasangan kunci SSH berlaku.
Jika instans berada dalam status Stopped, mulai instans dengan memanggil StartInstance agar pasangan kunci SSH berlaku.
Jika pasangan kunci SSH sudah tersambung ke instans, pasangan kunci SSH baru akan secara otomatis menggantikan yang asli.
Ini adalah operasi Batch yang mendukung keberhasilan parsial. Tanggapan HTTP 200 hanya menunjukkan bahwa permintaan telah diproses, bukan bahwa semua instans berhasil disambungkan. Periksa nilai FailCount serta bidang Code dan Success dari setiap elemen di Results.Result[] untuk menentukan hasil untuk setiap instans:
- Kesalahan tingkat permintaan: Kesalahan seperti parameter tidak valid, pasangan kunci tidak ada, atau lebih dari 50 instans dicegat sebelum eksekusi Batch. Kesalahan dikembalikan di tingkat teratas tanggapan dengan kode status HTTP non-200, dan seluruh permintaan Batch gagal.
- Kesalahan tingkat instans: Kesalahan seperti instans Windows, status instans yang tidak didukung, atau tipe instans yang tidak didukung hanya memengaruhi instans yang bersangkutan. Kode kesalahan dicatat di elemen Results.Result[] yang sesuai, dan permintaan keseluruhan tetap mengembalikan HTTP 200.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecs:AttachKeyPair

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

*KeyPair

acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah pasangan kunci SSH. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
KeyPairName	string	Yes	Nama pasangan kunci SSH.	testKeyPairName
InstanceIds	string	Yes	ID instans yang akan disambungkan dengan pasangan kunci SSH. Nilai dapat berupa array JSON yang terdiri dari hingga 50 ID instans. Pisahkan ID dengan koma (,).	["i-bp1gtjxuuvwj17zr**", "i-bp17b7zrsbjwvmfy", … "i-bp1h6jmbefj1ytos**"]

Elemen respons

Element	Type	Description	Example
	object
KeyPairName	string	Nama pasangan kunci.	testKeyPairName
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3*****83E
TotalCount	string	Jumlah total instans yang disambungkan dengan pasangan kunci.	2
FailCount	string	Jumlah instans yang gagal disambungkan dengan pasangan kunci.	1
Results	object
Result	array<object>	Kumpulan hasil yang menunjukkan apakah pasangan kunci berhasil disambungkan ke setiap instans.
	object	Hasil.
Code	string	Kode status operasi. Nilai 200 menunjukkan bahwa operasi berhasil.	200
Message	string	Paket operasi. Jika Code adalah 200, paketnya adalah berhasil.	berhasil
InstanceId	string	ID instans.	i-m5eg7be9ndloji64****
Success	string	Apakah operasi berhasil.	true

Contoh

Respons sukses

JSONformat

{
  "KeyPairName": "testKeyPairName",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3*****83E",
  "TotalCount": "2",
  "FailCount": "1",
  "Results": {
    "Result": [
      {
        "Code": "200",
        "Message": "successful",
        "InstanceId": "i-m5eg7be9ndloji64****",
        "Success": "true"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.	KeyPairName yang ditentukan tidak ada.
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.	Parameter InstanceIds yang ditentukan tidak valid.
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.	ID instans yang ditentukan tidak valid, atau konfigurasi optimasi I/O instans yang ditentukan tidak valid.
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login	Key pair tidak didukung untuk instans Windows.
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.