翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListHostKeys
ServerIdパラメータで指定されたサーバーのホストキーのリストを返します。
リクエストの構文
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
返されるホストキーの最大数。
タイプ：整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
- NextToken
-
返されなかった結果が他にもある場合は、
NextTokenパラメーターが返されます。ListHostKeysの値を以降の呼び出しに使用して、結果を一覧表示し続けることができます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
必須: いいえ
- ServerId
-
表示するホストキーが含まれているサーバーの識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
レスポンスの構文
{
"HostKeys": [
{
"Arn": "string",
"DateImported": number,
"Description": "string",
"Fingerprint": "string",
"HostKeyId": "string",
"Type": "string"
}
],
"NextToken": "string",
"ServerId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- HostKeys
-
各項目にホストキーの詳細が含まれる配列を返します。
型: ListedHostKey オブジェクトの配列
- NextToken
-
トークンを返すと、
ListHostKeysこのトークンを使用して再度呼び出し、追加の結果があれば、その結果を受け取ることができます。型: 文字列
長さの制限：最小長は 1 です。最大長は 6,144 です。
- ServerId
-
リストされたホストキーを含むサーバー ID を返します。
型: 文字列
長さの制限: 固定長は 19 です。
パターン：
s-([0-9a-f]{17})
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidNextTokenException
-
渡された
NextTokenパラメータが無効です。HTTP ステータスコード：400
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
