調用AttachKeyPair綁定一個SSH密鑰對到一臺或多臺Linux實例。
接口說明
當您使用該接口時，需要注意：
- Windows 實例不支持 SSH 密鑰對。
- 綁定 SSH 密鑰對后，將禁用用戶名加密碼的驗證方式。
- 如果實例處于運行中（Running）狀態，重啟實例（ RebootInstance ）后，SSH 密鑰對生效。
- 如果實例處于已停止（Stopped）狀態，啟動實例（ StartInstance ）后，SSH 密鑰對生效。
- 如果實例已經綁定了 SSH 密鑰對，新的 SSH 密鑰對自動替換原來的 SSH 密鑰對。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:AttachKeyPair | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}*KeyPair acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | SSH 密鑰對所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| KeyPairName | string | 是 | SSH 密鑰對名稱。 | testKeyPairName |
| InstanceIds | string | 是 | 綁定 SSH 密鑰對的實例 ID。取值可以由多臺實例 ID 組成一個 JSON 數組，最多支持 50 個 ID，ID 之間用半角逗號（,）隔開。 | ["i-bp1gtjxuuvwj17zr****", "i-bp17b7zrsbjwvmfy****", … "i-bp1h6jmbefj1ytos****"] |
返回參數
示例
正常返回示例
JSON格式
{
"KeyPairName": "testKeyPairName",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": "2",
"FailCount": "0",
"Results": {
"Result": [
{
"Code": "200",
"Message": "successful",
"InstanceId": "i-m5eg7be9ndloji64****",
"Success": "true"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidKeyPairName.NotFound | The specified KeyPairName does not exist in our records. | 指定的 KeyPairName 不存在。 |
| 400 | InvalidInstanceIds.ValueNotSupported | The specified parameter InstanceIds is not valid. | 指定的 InstanceIds 參數有誤。 |
| 400 | DependencyViolation.IoOptimize | The specified parameter InstanceIds is not valid. | 指定的實例 ID 不合法，指定的實例 IO 優化配置不合法。 |
| 403 | DependencyViolation.WindowsInstance | The instance creating is windows, cannot use ssh key pair to login | 指定的實例是 Windows 操作系統，此類實例不支持 SSH 密鑰對登錄。 |
| 403 | InstanceKeyPairLimitExceeded | The specified instances are beyond the permitted range. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |