ESA API で HTTP ヘッダールールを取得する - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

サイトの HTTP 受信リクエストヘッダー変更構成のリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:ListHttpIncomingRequestHeaderModificationRules

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。 ListSites 操作を呼び出してサイト ID を取得できます。	608665779308176
ConfigId	integer	任意	構成 ID。ListHttpIncomingRequestHeaderModificationRules 操作を呼び出して構成 ID を取得できます。	424371770570752
ConfigType	string	任意	構成タイプ。このパラメーターを使用してグローバル構成またはルール構成をクエリできます。有効な値: global: グローバル構成をクエリします。 rule: ルール構成をクエリします。列挙値: rule : ルール構成。 global : グローバル構成。	rule
RuleName	string	任意	ルール名。	rule_example
PageNumber	integer	任意	ページングクエリのページ番号。値は 1 以上である必要があります。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。有効な値: 1～500。	20
SiteVersion	integer	任意	サイト構成のバージョン番号。バージョン管理が有効なサイトの場合、このパラメーターを使用して構成が効果を持つサイトバージョンを指定できます。デフォルト値はバージョン 0 です。	0

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	7FB6EBC8-8849-5FC6-890E-3A761A5CD42D
Configs	array<object>	HTTP 受信リクエストヘッダー変更構成のリスト。
	array<object>	HTTP 受信リクエストヘッダー変更構成の詳細。
ConfigId	integer	構成 ID。	429422870243328
SiteVersion	integer	サイト構成のバージョン番号。バージョン管理が有効なサイトの場合、このパラメーターを使用して構成が効果を持つサイトバージョンを指定できます。デフォルト値はバージョン 0 です。	0
Sequence	integer	ルールの実行順序。値が小さいほど優先度が高くなります。	1
Rule	string	ルールの内容。条件式を使用してユーザーリクエストを照合します。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。2 つの使用シナリオがあります: すべての受信リクエストに一致: 値を true に設定します。指定されたリクエストに一致: カスタム式に値を設定します。例: (http.host eq "video.example.com")。	(http.host eq "video.example.com")
RuleEnable	string	ルールスイッチ。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。有効な値: on: 有効。 off: 無効。	on
RuleName	string	ルール名。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。	rule_example
ConfigType	string	構成タイプ。有効な値: global: グローバル構成。 rule: ルール構成。	rule
RequestHeaderModification	array<object>	リクエストヘッダーの変更。追加、削除、変更の操作をサポートします。
	object	リクエストヘッダー変更の詳細。
Name	string	リクエストヘッダーの名前。	headerName
Operation	string	操作。指定可能な値は以下のとおりです。 add：レスポンスヘッダーを追加します。 del：レスポンスヘッダーを削除します。 modify：レスポンスヘッダーを変更します。	add
Value	string	リクエストヘッダーの値。	headerValue
Type	string	値のタイプ。有効な値： static dynamic	static
PageNumber	integer	現在のページ番号。PageNumber リクエストパラメーターと同じです。	1
PageSize	integer	1 ページあたりのエントリ数。デフォルト値: 500。有効な値: 1～500。	20
TotalCount	integer	エントリの総数。	10
TotalPage	integer	ページの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "7FB6EBC8-8849-5FC6-890E-3A761A5CD42D",
  "Configs": [
    {
      "ConfigId": 429422870243328,
      "SiteVersion": 0,
      "Sequence": 1,
      "Rule": "(http.host eq \"video.example.com\")",
      "RuleEnable": "on",
      "RuleName": "rule_example",
      "ConfigType": "rule",
      "RequestHeaderModification": [
        {
          "Name": "headerName",
          "Operation": "add",
          "Value": "headerValue",
          "Type": "static"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 10,
  "TotalPage": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。