AttachKeyPair - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengikat 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 mengikat pasangan kunci SSH ke instans, otentikasi menggunakan nama pengguna dan kata sandi dinonaktifkan.
Jika instans berada dalam status Running, restart instans (RebootInstance) agar pasangan kunci SSH berlaku.
Jika instans berada dalam status Stopped, mulai instans (StartInstance) agar pasangan kunci SSH berlaku.
Jika pasangan kunci SSH sudah terikat ke instans, pasangan kunci SSH baru akan secara otomatis menggantikan yang lama.

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 Alibaba Cloud terbaru.	cn-hangzhou
KeyPairName	string	Yes	Nama pasangan kunci SSH.	testKeyPairName
InstanceIds	string	Yes	ID instans yang ingin Anda ikat pasangan kunci SSH-nya. Nilai dapat berupa array JSON yang terdiri dari hingga 50 ID instans. Pisahkan beberapa 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-A3DC0DE3C83E
TotalCount	string	Jumlah total instans yang terikat pasangan kunci.	2
FailCount	string	Jumlah instans yang gagal diikat pasangan kunci.	0
Results	object
Result	array<object>	Hasil pengikatan pasangan kunci.
	object
Code	string	Kode status yang dikembalikan untuk operasi. Nilai 200 menunjukkan bahwa operasi berhasil.	200
Message	string	Informasi operasi yang dikembalikan. Ketika nilai Code adalah 200, nilai Message adalah successful.	successful
InstanceId	string	ID instans.	i-m5eg7be9ndloji64****
Success	string	Menunjukkan apakah operasi berhasil.	true

Contoh

Respons sukses

JSONformat

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

Respons error

JSONformat

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidKeyPairName.NotFound	KeyPairName yang ditentukan tidak ada dalam catatan kami.	KeyPairName yang ditentukan tidak ada.
400	InvalidInstanceIds.ValueNotSupported	Parameter InstanceIds yang ditentukan tidak valid.	Parameter InstanceIds yang ditentukan tidak valid.
400	DependencyViolation.IoOptimize	Parameter InstanceIds yang ditentukan tidak valid.	ID instans yang ditentukan tidak valid, atau konfigurasi optimasi I/O dari instans yang ditentukan tidak valid.
403	DependencyViolation.WindowsInstance	Instans yang dibuat adalah windows, tidak dapat menggunakan pasangan kunci ssh untuk masuk	Instans yang ditentukan menjalankan sistem operasi Windows, yang tidak mendukung login berdasarkan pasangan kunci SSH.
403	InstanceKeyPairLimitExceeded	Instans yang ditentukan berada di luar rentang yang diizinkan.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.