CreatePage API によるブランド化 WAF ブロックページ構築 - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

今すぐお試しください

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

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	カスタムページの名前。命名の推奨事項: ルールで簡単にリファレンスできるよう、`blocked_page_v1` のように英数字とアンダースコアで構成される短い名前を使用してください。具体的な文字セット、最大値の長さ、一意性、その他の制約については、サーバー側のカスタムページ命名仕様に準拠します。	example
Description	string	任意	コンソールのリストでページの用途を識別するために使用されるページの説明。推奨コンテンツ: 「CC 保護ブロックページ - 日本語版」など、ページのシナリオと ID 情報を使用してください。これはオプションフィールドです。指定しない場合、デフォルト値は空です。説明フィールドの最大値の長さはサーバー側の仕様に準拠します。	a custom deny page
ContentType	string	必須	ページコンテンツの MIME タイプ。この値は、マッチ後に HTTP `Content-Type` レスポンスヘッダーとしてクライアントに返されます。一般的な値: `text/html`: HTML ページ。`Content` パラメーターには、UTF-8 HTML テキストの BASE64 エンコード値をセットする必要があります。 `application/json`: JSON 応答。`Content` パラメーターには、有効な JSON 文字列の BASE64 エンコード値をセットする必要があります。 `text/plain`: プレーンテキスト。`Content` パラメーターには、プレーンテキストコンテンツの BASE64 エンコード値をセットする必要があります。説明注: サポートされている ContentType 値の完全なリストは、サーバー側の仕様に準拠します。指定した `ContentType` が `Content` の実際のフォーマットと一致しない場合、クライアントがページを正しくレンダリングできない可能性があります。	text/html
Content	string	任意	BASE64 エンコード済みのページコンテンツ。実際のコンテンツフォーマットは `ContentType` の値と一致している必要があります。エンコーディング方式: UTF-8 エンコーディングを使用して、元のページコンテンツをバイト文字列にエンコードします。バイト文字列に標準 BASE64 エンコーディングを適用します。例: 元のコンテンツ: `<html>hello page</html>` BASE64: `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=` 説明最大値のサイズ、サポートされている文字セット、セキュリティフィルタリングルールは、サーバー側のカスタムページ仕様に準拠します。	PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
SiteIds	array	任意	このカスタムページに関連付ける Web サイト ID のリスト。 Web サイト ID は、`ListSites` 操作を呼び出すことで取得できます。空のリストを渡した場合 (Web サイトが関連付けられていない場合)、ページは作成されますが有効ではありません。後で `UpdatePage` 操作を呼び出して Web サイトを関連付けることができます。リストに現在のアカウントに属さない Web サイト ID が含まれている場合、`InvalidParameter` エラーが返されます。
	integer	任意	関連付けられた Web サイトの ID。	1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Id	integer	カスタム応答ページの ID。ID は ListPages 操作を呼び出すことで取得できます。	50000001

例

成功レスポンス

JSONJSON

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Id": 50000001
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The specified parameter is invalid.	入力パラメーターのフォーマット検証が失敗しました。有効な値を指定してください。
400	InternalException	Failed to call the service. Try again later or contact technical support.	サービスの呼び出しに失敗しました。後でもう一度お試しいただくか、詳細についてはカスタマーサポートにお問い合わせください。
403	%s.NotSupport	The specified resource type %s is not supported.	指定されたリソースタイプはサポートされていません。このリソースタイプを使用するには、連絡先までお問い合わせください。
403	%s.OverQuota	The quantity of %s exceeds the quota.	リソース数がクォータ制限を超えています。クォータの引き上げをリクエストする場合は、連絡先までお問い合わせください。
403	%s.WrongValueMatched	The value of specified parameter %s can not pass the matching check.	需要手动添加日文描述
403	Page.SiteAlreadyBound	The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.	指定されたサイトは、すでに同じタイプの別のカスタム応答ページにバインドされています。既存のページとの関連付けを解除してから、もう一度お試しください。

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

変更履歴

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