DescribeHostKey - AWS Transfer Family

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeHostKey

傳回與所指定之主機金鑰的詳細資HostKeyIdServerId

請求語法

{ "HostKeyId": "string", "ServerId": "string" }

請求參數

如需所有動作的一般參數相關資訊,請參閱《Common Parameters》。

請求接受採用 JSON 格式的下列資料。

HostKeyId

您要描述之主機金鑰的識別碼。

類型:字串

長度約束:固定長度為 25。

模式:hostkey-[0-9a-f]{17}

必要:是

ServerId

包含您要描述之主機金鑰之伺服器的識別碼。

類型:字串

長度約束:固定長度為 19。

模式:s-([0-9a-f]{17})

必要:是

回應語法

{ "HostKey": { "Arn": "string", "DateImported": number, "Description": "string", "HostKeyFingerprint": "string", "HostKeyId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" } }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

HostKey

返回指定主機密鑰的詳細信息。

類型:DescribedHostKey 物件

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InternalServiceError

當在AWS Transfer Family服務中發生錯誤時,拋出此異常。

HTTP 狀態碼:500

InvalidRequestException

當客戶端提交格式錯誤的請求時,拋出此異常。

HTTP 狀態碼:400

ResourceNotFoundException

當 AWS Transfer Family 服務找不到資源時,會擲回此例外狀況。

HTTP 狀態碼:400

ServiceUnavailableException

申請失敗,因為 AWS Transfer Family 服務不可用。

HTTP 狀態碼:500

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: