ListTagsForResource - AWS Transfer Family
請求語法請求參數回應語法回應元素錯誤範例另請參閱

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

ListTagsForResource

列出與您指定的 Amazon 資源名稱 (ARN) 相關聯的所有標籤。資源可以是使用者、伺服器或角色。

請求語法

{
   "Arn": "string",
   "MaxResults": number,
   "NextToken": "string"
}

請求參數

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

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

Arn

請求與特定 Amazon 資源名稱 (ARN) 相關聯的標籤。ARN 是特定 AWS 資源 (例如伺服器、使用者或角色) 的識別碼。

類型：字串

長度限制︰長度下限為 20。長度上限為 1600。

模式：arn:\S+

必要：是

MaxResults

指定要傳回作為ListTagsForResource要求回應的標籤數目。

類型：整數

有效範圍：最小值為 1。最大值為 1000。

必要：否

NextToken

當您從ListTagsForResource作業要求其他結果時，會在輸入中傳回NextToken參數。然後，您可以將後續指令傳遞至NextToken參數，以繼續列出其他標籤。

類型：字串

長度限制：長度下限為 1。長度上限為 6144。

必要：否

回應語法

{
   "Arn": "string",
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

回應元素

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

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

Arn

您指定要列出標籤的 ARN。

類型：字串

長度限制︰長度下限為 20。長度上限為 1600。

模式：arn:\S+

NextToken

當您可以從ListTagsForResource呼叫中取得其他結果時，會在輸出中傳回NextToken參數。然後，您可以將後續指令傳遞至NextToken參數，以繼續列出其他標籤。

類型：字串

長度限制：長度下限為 1。長度上限為 6144。

Tags

指定給資源的鍵值配對，通常用於分組和搜尋項目。標籤是您定義的中繼資料。

類型：Tag 物件陣列

陣列成員：項目數下限為 1。項目數上限為 50。

錯誤

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

InternalServiceError

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

HTTP 狀態碼：500

InvalidNextTokenException

傳遞的NextToken參數無效。

HTTP 狀態碼：400

InvalidRequestException

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

HTTP 狀態碼：400

ServiceUnavailableException

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

HTTP 狀態碼：500

範例

範例

下列範例會列出具有您指定 ARN 之資源的標籤。

請求範例


{
   "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef"
}

範例

此範例說明的一種用法 ListTagsForResource。

回應範例


{
   "Tags": [ 
      { 
         "Key": "Name",
         "Value": "MyServer"
      }
   ]
}

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：