翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
API リクエストを作成する
のクエリリクエスト AWS Resource Groups は、 や などの HTTP 動詞を使用する HTTP GETまたは HTTPS リクエストですPOST。
Resource Groups エンドポイント
エンドポイントは、ウェブサービスのエントリポイントとして機能する URL です。レイテンシーを減らすリクエストを行うときに、適切な AWS リージョン エンドポイントを選択できます。Resource Groups で使用されるエンドポイントの詳細については、 のAWS Resource Groups「」を参照してくださいAmazon Web Services 全般のリファレンス。
クエリパラメータ
各クエリリクエストには、認証とアクションの選択を処理するための一般的なパラメータが含まれている必要があります。詳細については、 AWS Resource Groups API リファレンスの「共通パラメータ」を参照してください。
一部の API オペレーションは、パラメータのリストを取得します。これらのリストは、次の表記を使用して指定します。
param.member.n
の値は 1 から始まる整数nです。パラメータのリストはすべて、1 つのパラメータのみを含むリストを含め、この表記に従う必要があります。クエリパラメータリストは次の例のようになります。
&attribute.member.1=this &attribute.member.2=that
リクエスト識別子
AWS クエリ API からのすべてのレスポンスには、 ResponseMetadata要素を含む RequestId要素があります。この文字列は、追跡情報を提供するために が AWS 割り当てる一意の識別子です。RequestId はすべてのレスポンスの一部として含まれていますが、読みやすさを向上させ、冗長性を減らすために、個々の API ドキュメントページには記載されていません。
クエリ API 認証
クエリリクエストは、HTTP または HTTPS のいずれかで送信できます。使用するプロトコルに関係なく、すべてのクエリリクエストに署名を含める必要があります。署名の作成と含めの詳細については、のAWS 「 API リクエストの署名」を参照してくださいAmazon Web Services 全般のリファレンス。
利用可能なライブラリ
AWS は、コマンドラインツールやクエリ API の代わりに言語固有の APIs を使用してアプリケーションを構築するソフトウェア開発者向けに、ライブラリ、サンプルコード、チュートリアル、その他のリソースを提供します。これらのライブラリには、リクエスト認証、リクエストの再試行、エラー処理などの基本的な関数 (APIs には含まれていません) が用意されているため、簡単に開始できます。Resource Groups ライブラリとリソースは、次の言語とプラットフォームで使用できます。
すべての言語のライブラリとサンプルコードの詳細については、「サンプルコードとライブラリ」を参照してください。
POST メソッドを使用した API リクエストの実行
AWS SDKs のいずれかを使用しない場合は、 リクエストメソッドを使用して HTTP 経由で Resource Groups POSTリクエストを行うことができます。POST メソッドでは、リクエストの ヘッダーに オペレーションを指定し、リクエストの本文に JSON 形式でオペレーションのデータを指定する必要があります。
| ヘッダー名 | ヘッダー値 |
|---|---|
Host |
AWS Resource Groups エンドポイント。例: |
X-Amz-Date |
HTTP Date ヘッダーまたは the AWS x-amz-date ヘッダーのいずれかにタイムスタンプを指定する必要があります。一部の HTTP クライアントライブラリでは、日付ヘッダーを設定できません。x-amz-date ヘッダーが存在する場合、システムはリクエスト認証中に Date ヘッダーを無視します。 x-amz-date ヘッダーは ISO 8601 基本形式で指定する必要があります。例: |
Authorization |
がリクエストの有効性と信頼性を確保するために AWS 使用する認可パラメータのセット。このヘッダーの作成の詳細については、の「署名バージョン 4 の署名プロセス」を参照してくださいAmazon Web Services 全般のリファレンス。 |
X-Amz-Target |
Resource Groups の名前空間とバージョン、および実行するオペレーションを指定します。
注記Resource Groups には、常にバージョン を使用します たとえば、
|
Content-Type |
入力形式を指定します。次の値を使用します。
|
Accept |
レスポンス形式を指定します。次の値を使用します。
|
Content-Length |
バイト単位のペイロードのサイズ。 |
Content-Encoding |
入力と出力のエンコード形式を指定します。次の値を使用します。
|
以下は、 にタグ付けされたすべてのリソースを含むリソースグループを作成するための HTTP リクエストのヘッダーの例ですStage=Test。この例では、読みやすくするために、このAuthorization行はここで単語ラップされています。実際のリクエストにラップしないでください。
POST / HTTP/1.1 Host: resource-groups.us-east-1.amazonaws.com X-Amz-Date: 20180112T092034Z Accept-Encoding: identity Authorization: AWS4-HMAC-SHA256 Credential=REDACTED/20220113/us-west-2/resource-groups/aws4_request, SignedHeaders=content-encoding;content-length;content-type;host;x-amz-date;x-amz-target, Signature=EXAMPLE5cb91f88f1EXAMPLEa02d3af93dEXAMPLE91e5d03588EXAMPLE88ff1d Content-Type: application/json Accept: application/json Content-Length: 283 { "Description": "Resources created for the testing stage.", "Name": "QueryGroup", "ResourceQuery": { "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}", "Type": "TAG_FILTERS_1_0" }, "Tags": {"Department": "Finance"} }
