日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

HTTP の詳細

寄稿者 dmp-netapp このページの PDF をダウンロード

Astra REST API は、 HTTP および関連パラメータを使用して、リソースとコレクションに対して操作を行います。Astra HTTP 実装の詳細を以下に示します。

API トランザクションと CRUD モデル

Astra REST API は、明確に定義された処理と状態の移行を含むトランザクションモデルを実装します。

要求と応答の API トランザクション

すべての REST API 呼び出しは、 Astra サービスへの HTTP 要求として実行されます。要求ごとに、関連付けられた応答がクライアントに生成されます。この要求と応答のペアで API トランザクションを使用できます。

CRUD 操作モデルのサポート

Astra REST API で使用できる各リソースインスタンスとコレクションには、 *CRUD * モデルに基づいてアクセスします。4 つの操作があり、それぞれが単一の HTTP メソッドにマッピングされます。処理は次のとおりです。

  • 作成

  • 読み取り

  • 更新

  • 削除

一部の Astra リソースでは、これらの操作の一部のみがサポートされています。を確認しておきます "API リファレンス" 特定の API 呼び出しに関する詳細については、を参照してください。

HTTP メソッド

次の表に、 API でサポートされる HTTP メソッドまたは動詞を示します。

メソッド CRUD 説明

取得

読み取り

リソースインスタンスまたはコレクションのオブジェクトプロパティを取得します。これは、コレクションとともに使用される場合、 * list * 演算と見なされます。

投稿( Post )

作成

入力パラメータに基づいて新しいリソースインスタンスを作成します。長期 URL は 'Location' 応答ヘッダーで返されます

PUT

更新

指定した JSON 要求の本文でリソースインスタンス全体を更新します。ユーザが変更できないキー値は保持されます。

削除

削除

既存のリソースインスタンスを削除します。

要求と応答のヘッダー

次の表に、 Astra REST API で使用される HTTP ヘッダーを示します。

注記 を参照してください "RFC 7232" および を参照してください。
ヘッダー を入力します 使用上の注意

同意します

リクエスト

値が「 * / * 」または指定されていない場合、「 application/json 」は Content-Type 応答ヘッダーで返されます。値が Astra リソースのメディアタイプに設定されている場合、同じメディアタイプが Content-Type ヘッダーに返されます。

承認

リクエスト

ユーザーの API キーを使用した Bearer トークン。

コンテンツタイプ

応答

「 Accept 」要求ヘッダーに基づいて返されます。

ETag

応答

RFC 7232 で定義されたとおりに、成功したに含まれます。値は、 JSON リソース全体の MD5 値を 16 進数で表したものです。

if-match

リクエスト

セクション 3.1 「 RFC 7232 」で説明されているように、 * PUT * 要求をサポートする前提条件の要求ヘッダーが実装されています。

If-Modified-Since の略

リクエスト

セクション 3.4 「 RFC 7232 」に記載されている前提条件の要求ヘッダーと、 *PUT * 要求のサポート。

If - unmodified- since

リクエスト

セクション 3.4 「 RFC 7232 」に記載されている前提条件の要求ヘッダーと、 *PUT * 要求のサポート。

場所

応答

新しく作成されたリソースの完全な URL が含まれます。

クエリパラメータ

リソースコレクションでは、次のクエリパラメータを使用できます。を参照してください "コレクションの操作" を参照してください。

クエリパラメータ 説明

含める

コレクションを読み取るときに返すフィールドが含まれています。

フィルタ

コレクションの読み取り時にリソースが返されるために一致しなければならないフィールドを示します。

OrderBy

コレクションの読み取り時に返されるリソースのソート順序を指定します。

制限( Limit )

コレクションの読み取り時に返されるリソースの最大数を制限します。

スキップします

コレクションの読み取り時に、パスオーバーおよびスキップするリソースの数を設定します。

カウント

メタデータオブジェクトで返されるリソースの総数。

HTTP ステータスコード

Astra REST API で使用される HTTP ステータスコードを次に示します。

注記 Astra REST API は、 HTTP API * 標準の問題の詳細も使用します。を参照してください "診断とサポート" を参照してください。
コード 意味 説明

200

わかりました

新しいリソースインスタンスを作成しない呼び出しが成功したことを示します。

201

作成済み

オブジェクトが作成され、場所の応答ヘッダーにオブジェクトの一意の識別子が含まれている。

204

コンテンツがありません

要求は成功しましたが、コンテンツが返されませんでした。

400

無効な要求です

要求の入力が認識されないか不適切です。

401

権限がありません

ユーザは認証されていないため、認証が必要です。

403

禁止されている

認証エラーによりアクセスが拒否されました。

404

が見つかりません

要求で参照されているリソースが存在しません。

409

競合しています

オブジェクトがすでに存在するため、オブジェクトの作成に失敗しました。

500

内部エラー

サーバで一般的な内部エラーが発生しました。

503

サービスを利用できません

サービスは何らかの理由で要求を処理する準備ができていません。