ListHttpsApplicationConfigurations - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

複数の HTTPS アプリケーション構成を照会します。

今すぐお試しください

この 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:ListHttpsApplicationConfigurations

list

*Site

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

なし

リクエストパラメーター

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

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Configs	array<object>	レスポンス本文の構成。
	object
ConfigId	integer	構成 ID。	395386449776640
SiteVersion	integer	サイト構成のバージョン番号。構成バージョン管理が有効なサイトの場合、このパラメーターを使用して構成が効果を持つサイトバージョンを指定できます。デフォルト値: バージョン 0。	1
Sequence	integer	ルールの実行順序。値が小さいほど優先度が高くなります。	1
RuleEnable	string	ルールスイッチ。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。有効な値: on: 有効。 off: 無効。	on
Rule	string	ルールの内容。条件付きの式を使用してユーザーリクエストを照合します。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。2 つの使用シナリオがあります: すべての受信リクエストに一致: 値を true に設定します。指定されたリクエストに一致: 値をカスタム式に設定します。例: (http.host eq "video.example.com")。	(http.host eq \"video.example.com\")
RuleName	string	ルール名。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。	rule_example
ConfigType	string	構成タイプ。このパラメーターを使用して、グローバル構成またはルール構成をクエリできます。有効な値: global: グローバル構成をクエリします。 rule: ルール構成をクエリします。	global
HttpsForce	string	強制 HTTPS を有効にするかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
HttpsForceCode	string	強制 HTTPS リダイレクトの状態コード。有効な値: 301 302 307 308。	301
AltSvc	string	Alt-Svc 機能スイッチ。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
AltSvcClear	string	Alt-Svc ヘッダーに clear パラメーターを含めるかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
AltSvcPersist	string	Alt-Svc ヘッダーに persist パラメーターを含めるかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
AltSvcMa	string	Alt-Svc の有効期間（秒単位）。デフォルト値: 86400 秒。	86400
Hsts	string	HSTS を有効にするかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
HstsMaxAge	string	HSTS の有効期限時間（秒単位）。	3600
HstsIncludeSubdomains	string	HSTS にサブドメインを含めるかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
HstsPreload	string	HSTS プリロードを有効にするかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
HttpsSniVerify	string	SNI 検証を有効にするかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
HttpsNoSniDeny	string	SNI を含まない TLS ハンドシェイクリクエストの拒否を有効にするかどうか。デフォルトでは無効です。有効な値: on: 有効。 off: 無効。	on
HttpsSniWhitelist	string	許可される SNI ホワイトリストエントリのリストを指定します。スペースで区切ります。	abc edf
PageNumber	integer	現在のページ番号。リクエストパラメーター PageNumber と同じです。	1
PageSize	integer	ページサイズ。	10
TotalCount	integer	レコードの総数。	16
TotalPage	integer	ページの総数。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "HttpsForce": "on",
      "HttpsForceCode": "301",
      "AltSvc": "on",
      "AltSvcClear": "on",
      "AltSvcPersist": "on",
      "AltSvcMa": "86400",
      "Hsts": "on",
      "HstsMaxAge": "3600",
      "HstsIncludeSubdomains": "on",
      "HstsPreload": "on",
      "HttpsSniVerify": "on",
      "HttpsNoSniDeny": "on",
      "HttpsSniWhitelist": "abc edf"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16,
  "TotalPage": 2
}

エラーコード

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.

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

変更履歴

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