AttachKeyPair - - Alibaba Cloud Dokümantasyon Merkezi

Bir veya daha fazla Linux örneğine bir SSH anahtar çifti bağlar.

Operation description

İşlem açıklaması

Bu işlemi çağırırken aşağıdaki hususlara dikkat edin:

Windows örnekleri SSH anahtar çiftlerini desteklemez.
Bir SSH anahtar çifti bağladıktan sonra, kullanıcı adı ve parola kullanılarak kimlik doğrulama devre dışı bırakılır.
Örnek Running durumundaysa, SSH anahtar çiftinin etkili olması için RebootInstance işlemini çağırarak örneği yeniden başlatın.
Örnek Stopped durumundaysa, SSH anahtar çiftinin etkili olması için StartInstance işlemini çağırarak örneği başlatın.
Bir örneğe zaten bir SSH anahtar çifti bağlıysa, yeni SSH anahtar çifti orijinal olanın yerini otomatik olarak alır.
Bu, kısmi başarıyı destekleyen bir toplu işlemdir. HTTP 200 yanıtı yalnızca isteğin işlendiğini gösterir, tüm örneklerin başarıyla bağlandığını göstermez. Her örnek için sonucu belirlemek amacıyla FailCount değerini ve Results.Result[] içindeki her öğenin Code ve Success alanlarını kontrol edin:
- İstek düzeyindeki hatalar: Geçersiz parametreler, var olmayan anahtar çifti veya 50'den fazla örnek gibi hatalar toplu yürütmeden önce yakalanır. Hata, 200 olmayan bir HTTP durum koduyla yanıtın en üst düzeyinde döndürülür ve toplu isteğin tamamı başarısız olur.
- Örnek düzeyindeki hatalar: Windows örneği, desteklenmeyen örnek durumu veya desteklenmeyen örnek türü gibi hatalar yalnızca ilgili örneği etkiler. Hata kodu ilgili Results.Result[] öğesine kaydedilir ve genel istek yine de HTTP 200 döndürür.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	SSH anahtar çiftinin bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.	cn-hangzhou
KeyPairName	string	Yes	SSH anahtar çiftinin adı.	testKeyPairName
InstanceIds	string	Yes	SSH anahtar çiftini bağlamak istediğiniz örneklerin kimlikleri. Değer, en fazla 50 örnek kimliğinden oluşan bir JSON dizisi olabilir. Kimlikleri virgül (,) ile ayırın.	["i-bp1gtjxuuvwj17zr**", "i-bp17b7zrsbjwvmfy", … "i-bp1h6jmbefj1ytos**"]

Response elements

Element	Type	Description	Example
	object
KeyPairName	string	Anahtar çiftinin adı.	testKeyPairName
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3*****83E
TotalCount	string	Anahtar çiftinin bağlandığı toplam örnek sayısı.	2
FailCount	string	Anahtar çiftinin bağlanamadığı örnek sayısı.	1
Results	object
Result	array<object>	Anahtar çiftinin her bir örneğe bağlanıp bağlanmadığını gösteren sonuç koleksiyonu.
	object	Sonuç.
Code	string	İşlem durum kodu. 200 değeri işlemin başarılı olduğunu gösterir.	200
Message	string	İşlem mesajı. Code 200 ise mesaj başarılıdır.	successful
InstanceId	string	Örnek kimliği.	i-m5eg7be9ndloji64****
Success	string	İşlemin başarılı olup olmadığını gösterir.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.