転送ルールをバッチで作成します。
操作説明
この操作を呼び出して転送ルールを作成する際は、次の点にご注意ください:
Redirect 操作を設定する場合、HttpCode パラメーターを除くすべてのパラメーターの値を指定する必要があります。
転送ルールに複数の操作を設定する場合、Rewrite 操作は ForwardGroup 操作タイプで設定する必要があります。
- CreateRules は非同期操作です。リクエストが送信されると、システムはリクエスト ID を返し、バックグラウンドで転送ルールを作成します。ListRules 操作を呼び出して、転送ルールの作成ステータスをクエリできます:
転送ルールが Provisioning ステータスの場合、作成中です。
転送ルールが Available ステータスの場合、作成済みです。
- 転送ルールは、次の最大数の条件 (RuleConditions) と操作 (RuleActions) をサポートします:
条件: Basic Edition は 5 個、Standard Edition は 10 個、WAF 有効エディションは 10 個。
操作: Basic Edition は 3 個、Standard Edition は 5 個、WAF 有効エディションは 5 個。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
alb:CreateRules |
create |
*LoadBalancer
*ServerGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ListenerId |
string |
必須 |
Application Load Balancer (ALB) リスナーの ID。 |
lsn-l16uo9y****** |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。 クライアントから値を生成して、異なるリクエスト間で値が一意になるようにします。トークンには ASCII 文字のみを含めることができます。 説明
このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。各リクエストの RequestId は一意です。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効値:
|
false |
| Rules |
array<object> |
必須 |
転送ルール。 |
|
|
array<object> |
必須 |
転送ルール。 |
||
| Priority |
integer |
必須 |
転送ルールの優先度。 |
1 |
| RuleActions |
array |
必須 |
転送ルールの操作。 |
|
|
array<object> |
必須 |
転送ルールの操作。 |
||
| FixedResponseConfig |
object |
任意 |
固定レスポンスを返す操作の設定。 |
|
| Content |
string |
任意 |
固定レスポンス。レスポンスのサイズは最大 1 KB で、ASCII 文字のみを含めることができます。 |
test |
| ContentType |
string |
任意 |
固定レスポンスのフォーマット。 有効値: text/plain、text/css、text/html、application/javascript、および application/json。 |
text/plain |
| HttpCode |
string |
任意 |
レスポンスの HTTP ステータスコード。有効値は 2xx、4xx、5xx です。x は数字です。 |
200 |
| ForwardGroupConfig |
object |
任意 |
リクエストを vServer グループに転送する操作の設定。 |
|
| ServerGroupTuples |
array |
任意 |
宛先 vServer グループ。 |
|
|
object |
任意 |
宛先 vServer グループ。 |
||
| ServerGroupId |
string |
任意 |
vServer グループ ID。 |
sgp-ffm94ovy7lqw****** |
| Weight |
integer |
任意 |
重み。値が大きいほど、重みが高くなります。重みが大きい vServer グループには、より多くのリクエストが転送されます。有効値: 0~100。
|
100 |
| ServerGroupStickySession |
object |
任意 |
vServer グループのセッション維持。 |
|
| Enabled |
boolean |
任意 |
セッション維持を有効にするかどうかを指定します。有効値:
|
false |
| Timeout |
integer |
任意 |
タイムアウト期間。単位: 秒。有効値: 1~86400。デフォルト値: 1000。 |
30 |
| InsertHeaderConfig |
object |
任意 |
ヘッダーを挿入する操作の設定。 |
|
| Key |
string |
任意 |
挿入するヘッダーのキー。キーの長さは 1~40 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。InsertHeaderConfig のヘッダーキーは同じにできません。 説明
次のヘッダーキーはサポートされていません (大文字と小文字は区別されません): |
key |
| Value |
string |
任意 |
挿入するヘッダーの値。
|
value |
| ValueType |
string |
任意 |
ヘッダー値のタイプ。有効値:
|
SystemDefined |
| Order |
integer |
必須 |
操作の順序。有効値: 1~50000。操作は昇順で実行されます。値は一意である必要があります。 |
1 |
| RedirectConfig |
object |
任意 |
リダイレクト操作の設定。 説明
httpCode を除く RedirectConfig のすべてのパラメーターにデフォルト値を使用することはできません。 |
|
| Host |
string |
任意 |
宛先ホスト名。有効値:
|
${host} |
| HttpCode |
string |
任意 |
リダイレクトメソッド。有効値: 301、302、303、307、および 308。 |
301 |
| Path |
string |
任意 |
宛先パス。有効値:
|
/ |
| Port |
string |
任意 |
宛先ポート。
|
443 |
| Protocol |
string |
任意 |
宛先プロトコル。有効値:
説明
|
HTTPS |
| Query |
string |
任意 |
宛先クエリ文字列。
|
${query} |
| RewriteConfig |
object |
任意 |
書き換え操作の設定。 説明
転送ルールに複数の操作を設定する場合、RewriteConfig 操作は ForwardGroup 操作タイプで使用する必要があります。 |
|
| Host |
string |
任意 |
内部リダイレクトの宛先ホスト名。有効値:
|
www.rewrite.alb |
| Path |
string |
任意 |
宛先パス。有効値:
|
/tea |
| Query |
string |
任意 |
内部リダイレクトのクエリ文字列。
|
${query} |
| Type |
string |
必須 |
操作タイプ。有効値:
説明
転送ルールには、ForwardGroup、Redirect、または FixedResponse 操作を含める必要があります。これらの操作を他の操作タイプで使用する場合は、これらの操作が最後に実行されるように設定する必要があります。 |
ForwardGroup |
| TrafficLimitConfig |
object |
任意 |
トラフィックの速度制限設定。 |
|
| QPS |
integer |
任意 |
1 秒あたりのクエリ数 (QPS)。有効値: 1~1000000。 |
5000 |
| PerIpQps |
integer |
任意 |
単一 IP アドレスの QPS。有効値: 1~1000000。 説明
QPS と PerIpQps の両方を指定する場合、PerIpQps の値は QPS の値より小さくする必要があります。 |
100 |
| TrafficMirrorConfig |
object |
任意 |
トラフィックミラーリングの設定。 |
|
| TargetType |
string |
任意 |
トラフィックがミラーリングされる宛先のタイプ。有効値:
|
ForwardGroupMirror |
| MirrorGroupConfig |
object |
任意 |
トラフィックがミラーリングされる vServer グループ。 |
|
| ServerGroupTuples |
array |
任意 |
トラフィックがミラーリングされる vServer グループ。 |
|
|
object |
任意 |
トラフィックがミラーリングされる vServer グループ。 |
||
| ServerGroupId |
string |
任意 |
vServer グループの ID。 |
sgp-u9cmf16iu69****** |
| RemoveHeaderConfig |
object |
任意 |
HTTP ヘッダーを削除するための設定。 |
|
| Key |
string |
任意 |
削除するヘッダーのキー。キーの長さは 1~40 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。RemoveHeader のヘッダーキーは同じにできません。
|
key |
| CorsConfig |
object |
任意 |
CORS の設定。 |
|
| AllowOrigin |
array |
任意 |
許可されるオリジン。 |
|
|
string |
任意 |
許可されるオリジンのリスト。アスタリスク (*) を 1 つだけ指定するか、1 つ以上の値を指定できます。
|
http://www.test.com |
|
| AllowMethods |
array |
任意 |
クロスオリジンリクエストで許可される HTTP メソッド。 |
|
|
string |
任意 |
クロスオリジンリクエストで許可される HTTP メソッド。有効値:
|
GET |
|
| AllowHeaders |
array |
任意 |
クロスオリジンリクエストで許可されるヘッダー。 |
|
|
string |
任意 |
クロスオリジンリクエストで許可されるヘッダー。アスタリスク (*) または 1 つ以上の値を指定できます。複数の値はカンマ (,) で区切ります。値は 1~32 文字の長さで、文字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。アンダースコア (_) とハイフン (-) は最初の文字または最後の文字にすることはできません。 |
AllowHeader |
|
| ExposeHeaders |
array |
任意 |
公開できるヘッダー。 |
|
|
string |
任意 |
公開できるヘッダー。アスタリスク (*) または 1 つ以上の値を指定できます。複数の値はカンマ (,) で区切ります。値は 1~32 文字の長さで、文字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。アンダースコア (_) とハイフン (-) は最初の文字または最後の文字にすることはできません。 |
ExposeHeader |
|
| AllowCredentials |
string |
任意 |
資格情報を許可するかどうかを指定します。有効値:
列挙値:
|
on |
| MaxAge |
integer |
任意 |
ブラウザでのプリフライトリクエストの最大キャッシュ時間。単位: 秒。 有効値: -1~172800。 |
600 |
| RuleConditions |
array |
必須 |
転送ルールの条件。 |
|
|
array<object> |
必須 |
転送ルールの条件。 |
||
| CookieConfig |
object |
任意 |
Cookie ベースのルーティング条件。 |
|
| Values |
array |
任意 |
Cookie のキーと値のペア。 |
|
|
object |
任意 |
Cookie のキーと値のペア。 |
||
| Key |
string |
任意 |
Cookie のキー。
|
key |
| Value |
string |
任意 |
Cookie の値。
|
value |
| HeaderConfig |
object |
任意 |
ヘッダーベースのルーティング条件。 |
|
| Key |
string |
任意 |
リクエストヘッダーのキー。
|
port |
| Values |
array |
任意 |
リクエストヘッダーの値。 |
|
|
string |
任意 |
リクエストヘッダーの値。同じヘッダーキーの値は同じにできません。
|
5006 |
|
| HostConfig |
object |
任意 |
ホストベースのルーティング条件。 |
|
| Values |
array |
任意 |
ホスト名。 |
|
|
string |
任意 |
ホスト名。1 つの条件に指定できるホスト名は 1 つだけで、他の条件のホスト名と同じにすることはできません。
|
www.example.com |
|
| MethodConfig |
object |
任意 |
メソッドベースのルーティング条件。 |
|
| Values |
array |
任意 |
HTTP リクエストメソッド。 |
|
|
string |
任意 |
リクエストメソッド。 有効値: HEAD、GET、POST、OPTIONS、PUT、PATCH、および DELETE。 |
PUT |
|
| PathConfig |
object |
任意 |
パスベースのルーティング条件。 |
|
| Values |
array |
任意 |
パス。 |
|
|
string |
任意 |
転送パス。パスは次の要件を満たす必要があります:
|
/test |
|
| QueryStringConfig |
object |
任意 |
クエリ文字列ベースのルーティング条件。 |
|
| Values |
array |
任意 |
クエリ文字列のキーと値のペア。 |
|
|
object |
任意 |
クエリ文字列のキーと値のペア。 |
||
| Key |
string |
任意 |
クエリ文字列のキー。
|
key |
| Value |
string |
任意 |
クエリ文字列の値。
|
value |
| ResponseHeaderConfig |
object |
任意 |
レスポンスヘッダーの設定。 |
|
| Key |
string |
任意 |
レスポンスヘッダーのキー。
|
key |
| Values |
array |
任意 |
レスポンスヘッダーの値。 |
|
|
string |
任意 |
レスポンスヘッダーの値。
|
value |
|
| ResponseStatusCodeConfig |
object |
任意 |
レスポンスステータスコードの設定。 |
|
| Values |
array |
任意 |
レスポンスステータスコード。 |
|
|
string |
任意 |
レスポンスステータスコード。 |
200 |
|
| Type |
string |
必須 |
条件のタイプ。有効値:
列挙値:
|
SourceIp |
| SourceIpConfig |
object |
任意 |
ソース IP アドレスベースのルーティング条件。 |
|
| Values |
array |
任意 |
ソース IP アドレスまたは CIDR ブロック。 |
|
|
string |
任意 |
1 つ以上の IP アドレスまたは CIDR ブロックを追加します。 転送ルールには最大 5 つのソース IP アドレスを追加できます。 |
192.168.XX.XX/32 |
|
| RuleName |
string |
必須 |
転送ルールの名前。 |
rule-443-64 |
| Direction |
string |
任意 |
転送ルールの方向。 列挙値:
|
Request |
| Tag |
array |
任意 |
タグ。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。タグキーは最大 128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。 |
test_tag_key |
| Value |
string |
任意 |
タグ値。タグ値は最大 128 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。 |
test_tag_value |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
複数の転送ルールを作成します。 |
||
| JobId |
string |
非同期タスクの ID。 |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
リクエスト ID。 |
365F4154-92F6-4AE4-92F8-7FF34B540710 |
| RuleIds |
array<object> |
転送ルール。 |
|
|
object |
転送ルール。 |
||
| RuleId |
string |
転送ルール ID。 |
rule-a3x3pg1yohq3lq**** |
| Priority |
integer |
転送ルールの優先度。有効値: 1~10000。値が小さいほど、優先度が高くなります。 説明
同じリスナーに対して作成された転送ルールの優先度は一意である必要があります。 |
10 |
例
成功レスポンス
JSONJSON
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
"RuleIds": [
{
"RuleId": "rule-a3x3pg1yohq3lq****",
"Priority": 10
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | |
| 400 | OperationDenied.IpGroupCanNotUsedForMirrorAction | The operation is not allowed because of %s. | |
| 400 | OperationDenied.SameGroupForForwardAndMirrorAction | The operation is not allowed because of %s. | |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | |
| 400 | Conflict.Priority | There is already %s having the same configuration with %s. | |
| 400 | ResourceQuotaExceeded.LoadBalancerRulesNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | QuotaExceeded.RuleWildcardsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | QuotaExceeded.RuleMatchEvaluationsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | QuotaExceeded.RuleActionsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | |
| 400 | Mismatch.Protocol | The %s is mismatched for %s and %s. | |
| 400 | OperationDenied.RewriteMissingForwardGroup | The operation is not allowed because of RewriteMissingForwardGroup. | |
| 400 | OperationDenied.MirrorActionSupportHttpGroupOnly | The operation is not allowed because of MirrorActionSupportHttpGroupOnly. | |
| 400 | OperationDenied.ProtocolMustSameForForwardGroupAction | The operation is not allowed because of ProtocolMustSameForForwardGroupAction. | |
| 404 | ResourceNotFound.Listener | The specified resource %s is not found. | |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。