1 つ以上の Linux ベースのインスタンスに SSH キーペアをアタッチします。

説明

本インターフェイスを呼び出す際は次の点に留意してください。

  • SSH キーペアは、Windows ベースのインスタンスではサポートされていません。
  • SSH キーペアがインスタンスにアタッチされると、インスタンスのユーザー名とパスワードの認証方法が無効になります。
  • インスタンスが実行状態の場合、 RebootInstance を呼び出してインスタンスを再起動し、操作を有効にします。
  • インスタンスが停止状態の場合、StartInstanceを呼び出してインスタンスを起動し、操作を有効にします。
  • アタッチされている SSH キーペアがすでにインスタンスに存在する場合、新しい SSH キーペアは元の SSH キーペアを自動的に置き換えます。

デバッグ

API Explorer でデバッグを実行できます。 API Explorer で各種操作を行い API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成などができます。

リクエストパラメーター

名前 データ型 必須 / 省略可能 説明
InstanceIds String 必須 ["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]

SSH キーペアをアタッチするインスタンスの ID 。 値には、最大 50 件のインスタンス ID で構成される JSON 配列が使用可能です。 複数の ID はコンマ ( , ) で区切る必要があります。

KeyPairName String 必須 FinanceJoshuaV25

SSH キーペアの名前。

RegionId String 必須 cn-hangzhou

SSH キーペアが設置されているリージョンの ID 。 DescribeRegionsを呼び出して、Alibaba Cloud リージョンの最新リストを表示できます。

Action String 省略可能 AttachKeyPair

実行する操作。 値を AttachKeyPair に設定します。

レスポンスパラメーター

名前 データ型 説明
FailCount String 0

キーペアのアタッチに失敗したインスタンスの数。

KeyPairName String FinanceJoshuaV25

キーペアの名前。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID。

Results

アタッチ操作の結果セット。

└Code String 200

返された操作のステータスコード。 200 はリクエストが成功したことを示します。

└InstanceId String i-instanceid1

インスタンスの ID。

└Message String successful

返された操作情報。 code の値が 200 の場合、message の値は successful になります。

└Success String true

操作が成功したかを示すレスポンスメッセージ。

TotalCount String 2

キーペアがバインドされているインスタンスの総数。

リクエストの例

https://ecs.aliyuncs.com/?Action=AttachKeyPair
&InstanceIds=["i-xxxxxxxxx", "i-yyyyyyyyy", … "i-zzzzzzzzz"]
&KeyPairName=FinanceJoshuaV25
&RegionId=cn-hangzhou 
&<Common request parameters>

通常のレスポンスの例

XML 形式

<AttachKeyPairResponse>
  <TotalCount>2</TotalCount>
  <RequestId>4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06</RequestId><RequestId> 4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06 </RequestId>
  <Results>
    </Result>
      <Message>AccessDenied</Message>
       <InstanceId> i-m5eg7be9ndloji64jknv </InstanceId>
      <Success>true</Success>
      <Code>200</Code>
    </Result>
    </Result>
      <Message>AccessDenied</Message>
       <InstanceId> i-m5e25x2mwr0hk33dwv0h </InstanceId>
      <Success>true</Success>
      <Code>200</Code>
    </Result>
  </Results>
  <FailCount>0</FailCount>
</AttachKeyPairResponse>

JSON 形式

{
	"TotalCount":2,
	"RequestId":"4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06",
	"Results":{
		"Result": {
			{
				"message":"successful",
				"InstanceId":"i-m5eg7be9ndloji64jknv",
				"Success":true,
				"code": "200",
			},
			{
				"message":"successful",
				"InstanceId":"i-m5e25x2mwr0hk33dwv0h",
				"Success":true,
				"code": "200",
			}
		]
	},
	"FailCount":0
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明 
403 DependencyViolation.WindowsInstance 作成するインスタンスが windowsベースです。ログインに ssh キーペアを使用することはできません。 指定された Windows ベースのインスタンスからキーペアをデタッチできない場合に返されるエラーメッセージ。
400 DependencyViolation.IoOptimize 指定されたパラメーター InstanceIds は無効です。 指定された InstanceId が無効な場合に表示されるエラーメッセージ。

エラーコードの表示