Amazon SQS XML API レスポンスの解釈 - Amazon Simple Queue Service
成功した XML 応答構造XML エラー応答構造

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon SQS XML API レスポンスの解釈

アクションリクエストに応答して、Amazon SQSはリクエスト結果を含むXMLデータ構造を返信します。詳細については、「Amazon Simple Notification Service APIリファレンス」の「キューアクション」を参照してください。

成功した XML 応答構造

リクエストが成功すると、メインのレスポンス要素にはアクションにちなんだ名前が付けられ、(たとえば、ActionNameResponse) Response が付加されます。

この要素には、以下の子要素が含まれています。

  • ActionNameResult-アクション固有の要素が含まれています。たとえば、CreateQueueResult 要素には QueueUrl 要素が含まれています。つまり、作成されたキューのURLが含まれています。

  • ResponseMetadata— RequestId が含まれ、その後にリクエストの汎用固有識別子 (UUID) が格納されます。

以下に、XML形式の正常なレスポンスの例を示します。

<CreateQueueResponse
   xmlns=https://sqs.us-east-2.amazonaws.com/doc/2012-11-05/
   xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
   xsi:type=CreateQueueResponse>
   <CreateQueueResult>
      <QueueUrl>https://sqs.us-east-2.amazonaws.com/770098461991/queue2</QueueUrl>
   </CreateQueueResult>
   <ResponseMetadata>
      <RequestId>cb919c0a-9bce-4afe-9b48-9bdf2412bb67</RequestId>
   </ResponseMetadata>
</CreateQueueResponse>

XML エラー応答構造

リクエストが正常に行われなかった場合、 Amazon SQSは常に主な応答要素を返信しますErrorResponse。この要素には Error 要素と RequestId 要素が含まれます。

Error 要素には、以下の子要素が含まれています。

  • Type-エラーがプロデューサーかコンシューマーのどちらかを特定します。

  • Code-エラーのタイプを特定します。

  • Message-読み取り可能な条件でエラー状況を特定します。

  • Detail-(オプション) エラーに関する追加の詳細を特定します。

RequestId要素には、リクエストのUUIDが含まれています。

以下に、XML形式のエラーレスポンスの例を示します。

<ErrorResponse>
   <Error>
      <Type>Sender</Type>
      <Code>InvalidParameterValue</Code>
      <Message>
         Value (quename_nonalpha) for parameter QueueName is invalid.
         Must be an alphanumeric String of 1 to 80 in length.
      </Message>
   </Error>
   <RequestId>42d59b56-7407-4c4a-be0f-4c88daeea257</RequestId>
</ErrorResponse>